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

Latest commit

 

History

History
93 lines (74 loc) · 4.14 KB

File metadata and controls

93 lines (74 loc) · 4.14 KB

Name

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

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 Name.Name1
schema class
static class Name.NameMap
output class for Map payloads
static class Name.Property
schema class
static class Name.SnakeCase
schema class
static class Name.Name2
schema class

Name1

public static class Name1
extends JsonSchema

A schema class that validates payloads

Description

Model for testing model name same as property name

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(
        new PropertyEntry("name", Name2.class)),
        new PropertyEntry("snake_case", SnakeCase.class)),
        new PropertyEntry("property", Property.class))
    ))),
    new KeywordEntry("required", new RequiredValidator(Set.of(
        "name"
    )))
));

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 NameMap validate(Map<String, Object> arg, SchemaConfiguration configuration)
FrozenList validate(List arg, SchemaConfiguration configuration)

NameMap

public static class NameMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static NameMap of(Map<String, Object> arg, SchemaConfiguration configuration)
int name()
value must be a 32 bit integer
int snake_case()
[optional] value must be a 32 bit integer
String property()
[optional]
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
name int value must be a 32 bit integer
snake_case int [optional] value must be a 32 bit integer
property String this is a reserved python keyword [optional]
anyStringName Object any string name can be used but the value must be the correct type [optional]

Property

public static class Property
extends StringJsonSchema

A schema class that validates payloads

Description

this is a reserved python keyword

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

SnakeCase

public static class SnakeCase
extends Int32JsonSchema

A schema class that validates payloads

Name2

public static class Name2
extends Int32JsonSchema

A schema class that validates payloads

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