ObjWithRequiredProps.md

ObjWithRequiredProps

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

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	ObjWithRequiredProps.ObjWithRequiredProps1 schema class
static class	ObjWithRequiredProps.ObjWithRequiredPropsMap output class for Map payloads
static class	ObjWithRequiredProps.A schema class

ObjWithRequiredProps1

public static class ObjWithRequiredProps1
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
ObjWithRequiredProps.ObjWithRequiredPropsMap validatedPayload =
    ObjWithRequiredProps.ObjWithRequiredProps1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "a",
            "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("a", A.class))     ))),     new KeywordEntry("required", new RequiredValidator(Set.of(         "a"     ))),     new KeywordEntry("allOf", new AllOfValidator(List.of(         ObjWithRequiredPropsBase.ObjWithRequiredPropsBase1.class     ))) ));

Method Summary

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

ObjWithRequiredPropsMap

public static class ObjWithRequiredPropsMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

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

A

public static class A
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]