ReqPropsFromExplicitAddProps.md

ReqPropsFromExplicitAddProps

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

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	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddProps1 schema class
static class	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddPropsMap output class for Map payloads
static class	ReqPropsFromExplicitAddProps.AdditionalProperties schema class

ReqPropsFromExplicitAddProps1

public static class ReqPropsFromExplicitAddProps1
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
ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddPropsMap validatedPayload =
    ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddProps1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "invalid-name",
            "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("required", new RequiredValidator(Set.of(         "invalid-name",         "validName"     ))),     new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class)) ));

Method Summary

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

ReqPropsFromExplicitAddPropsMap

public static class ReqPropsFromExplicitAddPropsMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ReqPropsFromExplicitAddPropsMap	of(Map<String, String> arg, SchemaConfiguration configuration)
String	validName()
String	get(String key) This schema has invalid Java names so this method must be used when you access instance["invalid-name"],
String	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

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

AdditionalProperties

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