JSONPatchRequestRemove.md

JSONPatchRequestRemove

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
static class	JSONPatchRequestRemove.JSONPatchRequestRemove1 schema class
static class	JSONPatchRequestRemove.JSONPatchRequestRemoveMapBuilder builder for Map payloads
static class	JSONPatchRequestRemove.JSONPatchRequestRemoveMap output class for Map payloads
static class	JSONPatchRequestRemove.Op schema class
enum	JSONPatchRequestRemove.StringOpEnums String enum
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

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.validation.MapUtils;
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
JSONPatchRequestRemove.JSONPatchRequestRemoveMap validatedPayload =
    JSONPatchRequestRemove.JSONPatchRequestRemove1.validate(
    new JSONPatchRequestRemove.JSONPatchRequestRemoveMapBuilder()
        .op("remove")

        .path("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("path", Path.class)),     new PropertyEntry("op", Op.class)) )
Set	required = Set.of(     "op",     "path" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestRemoveMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

JSONPatchRequestRemoveMap00Builder

public class JSONPatchRequestRemoveMap00Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestRemoveMap00Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Map<String, String>	build() Returns map input that should be used with Schema.validate

JSONPatchRequestRemoveMap01Builder

public class JSONPatchRequestRemoveMap01Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestRemoveMap01Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestRemoveMap00Builder	path(String value)

JSONPatchRequestRemoveMap10Builder

public class JSONPatchRequestRemoveMap10Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestRemoveMap10Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestRemoveMap00Builder	op(String value)
JSONPatchRequestRemoveMap00Builder	op(StringOpEnums value)

JSONPatchRequestRemoveMapBuilder

public class JSONPatchRequestRemoveMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestRemoveMapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestRemoveMap01Builder	op(String value)
JSONPatchRequestRemoveMap01Builder	op(StringOpEnums value)
JSONPatchRequestRemoveMap10Builder	path(String value)

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()

Op

public static class Op
extends JsonSchema

A schema class that validates payloads

Description

The operation to perform.

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.validation.MapUtils;
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());

// String validation
String validatedPayload = JSONPatchRequestRemove.Op.validate(
    "remove",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "remove" )

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringOpEnums arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringOpEnums

public enum StringOpEnums
extends Enum<StringOpEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
REMOVE	value = "remove"

Path

public static class Path
extends StringJsonSchema

A schema class that validates payloads

Description

A JSON Pointer path.

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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