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

JSONPatchRequestRemove.md

Latest commit

 

History

History
94 lines (73 loc) · 4.64 KB

JSONPatchRequestRemove.md

File metadata and controls

94 lines (73 loc) · 4.64 KB

JSONPatchRequestRemove

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

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 JSONPatchRequestRemove.JSONPatchRequestRemove1
schema class
static class JSONPatchRequestRemove.JSONPatchRequestRemoveMap
output class for Map payloads
static class JSONPatchRequestRemove.Op
schema class
static class JSONPatchRequestRemove.Path
schema class
static class JSONPatchRequestRemove.AdditionalProperties
schema class

JSONPatchRequestRemove1

public static class JSONPatchRequestRemove1
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("path", Path.class)),
        new PropertyEntry("op", Op.class))
    ))),
    new KeywordEntry("required", new RequiredValidator(Set.of(
        "op",
        "path"
    ))),
    new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class))
));

Method Summary

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

JSONPatchRequestRemoveMap

public static class JSONPatchRequestRemoveMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static JSONPatchRequestRemoveMap of(Map<String, String> arg, SchemaConfiguration configuration)
String op()
must be one of ["remove"]
String path()

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
op String The operation to perform. must be one of ["remove"]
path String A JSON Pointer path.

Op

public static class Op
extends JsonSchema

A schema class that validates payloads

Description

The operation to perform.

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
    ))),
    new KeywordEntry("enum", new EnumValidator(Set.of(
        "remove"
)))
));

Method Summary

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

Path

public static class Path
extends StringJsonSchema

A schema class that validates payloads

Description

A JSON Pointer path.

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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