ObjectWithOptionalTestProp.md

ObjectWithOptionalTestProp

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

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	ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1 schema class
static class	ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMap output class for Map payloads
static class	ObjectWithOptionalTestProp.Test schema class

ObjectWithOptionalTestProp1

public static class ObjectWithOptionalTestProp1
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
ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMap validatedPayload =
    ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "test",
            "a"
        )
    ),
    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("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("test", Test.class))     ))) ));

Method Summary

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

ObjectWithOptionalTestPropMap

public static class ObjectWithOptionalTestPropMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
test	String		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

Test

public static class Test
extends StringJsonSchema

A schema class that validates payloads

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

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