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

ObjectModelWithArgAndArgsProperties.md

Latest commit

 

History

History
74 lines (58 loc) · 3.81 KB

ObjectModelWithArgAndArgsProperties.md

File metadata and controls

74 lines (58 loc) · 3.81 KB

ObjectModelWithArgAndArgsProperties

org.openapijsonschematools.components.schemas.ObjectModelWithArgAndArgsProperties.java public class ObjectModelWithArgAndArgsProperties

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 ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1
schema class
static class ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap
output class for Map payloads
static class ObjectModelWithArgAndArgsProperties.Args
schema class
static class ObjectModelWithArgAndArgsProperties.Arg
schema class

ObjectModelWithArgAndArgsProperties1

public static class ObjectModelWithArgAndArgsProperties1
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("properties", new PropertiesValidator(Map.ofEntries(
        new PropertyEntry("arg", Arg.class)),
        new PropertyEntry("args", Args.class))
    ))),
    new KeywordEntry("required", new RequiredValidator(Set.of(
        "arg",
        "args"
    )))
));

Method Summary

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

ObjectModelWithArgAndArgsPropertiesMap

public static class ObjectModelWithArgAndArgsPropertiesMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

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

Args

public static class Args
extends StringJsonSchema

A schema class that validates payloads

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

Arg

public static class Arg
extends StringJsonSchema

A schema class that validates payloads

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

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