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

Animal.md

Latest commit

 

History

History
79 lines (63 loc) · 3.78 KB

Animal.md

File metadata and controls

79 lines (63 loc) · 3.78 KB

Animal

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

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 Animal.Animal1
schema class
static class Animal.AnimalMap
output class for Map payloads
static class Animal.Color
schema class
static class Animal.ClassName
schema class

Animal1

public static class Animal1
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("className", ClassName.class)),
        new PropertyEntry("color", Color.class))
    ))),
    new KeywordEntry("required", new RequiredValidator(Set.of(
        "className"
    )))
));

Method Summary

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

AnimalMap

public static class AnimalMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static AnimalMap of(Map<String, Object> arg, SchemaConfiguration configuration)
String className()
String color()
[optional] if omitted the server will use the default value of red
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
className String
color String [optional] if omitted the server will use the default value of red
anyStringName Object any string name can be used but the value must be the correct type [optional]

Color

public static class Color
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(
        String.class
    )))
));

Method Summary

Modifier and Type Method and Description
static String validate(String arg, SchemaConfiguration configuration)

ClassName

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