Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

AdditionalPropertiesSchema.md

Latest commit

 

History

History
275 lines (221 loc) · 12.1 KB

AdditionalPropertiesSchema.md

File metadata and controls

275 lines (221 loc) · 12.1 KB

AdditionalPropertiesSchema

org.openapijsonschematools.client.components.schemas.AdditionalPropertiesSchema.java public class AdditionalPropertiesSchema

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type Class and Description
static class AdditionalPropertiesSchema.AdditionalPropertiesSchema1
schema class
static class AdditionalPropertiesSchema.Schema2
schema class
static class AdditionalPropertiesSchema.Schema2Map
output class for Map payloads
static class AdditionalPropertiesSchema.AdditionalProperties2
schema class
static class AdditionalPropertiesSchema.Schema1
schema class
static class AdditionalPropertiesSchema.Schema1Map
output class for Map payloads
static class AdditionalPropertiesSchema.AdditionalProperties1
schema class
static class AdditionalPropertiesSchema.Schema0
schema class
static class AdditionalPropertiesSchema.Schema0Map
output class for Map payloads
static class AdditionalPropertiesSchema.AdditionalProperties
schema class

AdditionalPropertiesSchema1

public static class AdditionalPropertiesSchema1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),
    new KeywordEntry("allOf", new AllOfValidator(List.of(
        Schema0.class,
        Schema1.class,
        Schema2.class
    )))
));

Method Summary

Modifier and Type Method and Description
static FrozenMap<String, Object> validate(Map<String, Object> arg, SchemaConfiguration configuration)

Schema2

public static class Schema2
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.MapMaker;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
AdditionalPropertiesSchema.Schema2Map validatedPayload =
    AdditionalPropertiesSchema.Schema2.validate(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),
    new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties2.class))
));

Method Summary

Modifier and Type Method and Description
static Schema2Map validate(Map<String, Object> arg, SchemaConfiguration configuration)

Schema2Map

public static class Schema2Map
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static Schema2Map of(Map<String, Object> arg, SchemaConfiguration configuration)
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName Object any string name can be used but the value must be the correct type [optional]

AdditionalProperties2

public static class AdditionalProperties2
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("maxLength", new MaxLengthValidator(5))
));

Method Summary

Modifier and Type Method and Description
static String validate(String arg, SchemaConfiguration configuration)
static Void validate(Void arg, SchemaConfiguration configuration)
static int validate(int arg, SchemaConfiguration configuration)
static long validate(long arg, SchemaConfiguration configuration)
static float validate(float arg, SchemaConfiguration configuration)
static double validate(double arg, SchemaConfiguration configuration)
static boolean validate(boolean arg, SchemaConfiguration configuration)
static FrozenMap<String, Object> Map<String, Object> arg, SchemaConfiguration configuration)
FrozenList validate(List arg, SchemaConfiguration configuration)

Schema1

public static class Schema1
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.MapMaker;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
AdditionalPropertiesSchema.Schema1Map validatedPayload =
    AdditionalPropertiesSchema.Schema1.validate(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),
    new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties1.class))
));

Method Summary

Modifier and Type Method and Description
static Schema1Map validate(Map<String, Object> arg, SchemaConfiguration configuration)

Schema1Map

public static class Schema1Map
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static Schema1Map of(Map<String, Object> arg, SchemaConfiguration configuration)
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName Object any string name can be used but the value must be the correct type [optional]

AdditionalProperties1

public static class AdditionalProperties1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("minLength", new MinLengthValidator(3))
));

Method Summary

Modifier and Type Method and Description
static String validate(String arg, SchemaConfiguration configuration)
static Void validate(Void arg, SchemaConfiguration configuration)
static int validate(int arg, SchemaConfiguration configuration)
static long validate(long arg, SchemaConfiguration configuration)
static float validate(float arg, SchemaConfiguration configuration)
static double validate(double arg, SchemaConfiguration configuration)
static boolean validate(boolean arg, SchemaConfiguration configuration)
static FrozenMap<String, Object> Map<String, Object> arg, SchemaConfiguration configuration)
FrozenList validate(List arg, SchemaConfiguration configuration)

Schema0

public static class Schema0
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.MapMaker;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
AdditionalPropertiesSchema.Schema0Map validatedPayload =
    AdditionalPropertiesSchema.Schema0.validate(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),
    new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class))
));

Method Summary

Modifier and Type Method and Description
static Schema0Map validate(Map<String, Object> arg, SchemaConfiguration configuration)

Schema0Map

public static class Schema0Map
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static Schema0Map of(Map<String, Object> arg, SchemaConfiguration configuration)
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName Object any string name can be used but the value must be the correct type [optional]

AdditionalProperties

public static class AdditionalProperties
extends AnyTypeJsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema
validate

[Back to top] [Back to Component Schemas] [Back to README]