io.swagger.v3.oas.models.media

Class Schema<T>

java.lang.Object

io.swagger.v3.oas.models.media.Schema<T>

Direct Known Subclasses:

ArraySchema, BinarySchema, BooleanSchema, ByteArraySchema, ComposedSchema, DateSchema, DateTimeSchema, EmailSchema, FileSchema, IntegerSchema, JsonSchema, MapSchema, NumberSchema, ObjectSchema, PasswordSchema, StringSchema, UUIDSchema

public class Schema<T>
extends Object

Schema

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#schemaObject", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#schemaObject"

Field Summary

Fields

Modifier and Type	Field and Description
protected T	_const
protected T	_default
protected List<T>	_enum
static String	BIND_TYPE_AND_TYPES
protected T	example
protected Map<String,Object>	jsonSchema
protected Object	jsonSchemaImpl

Constructor Summary

Constructors

Modifier	Constructor and Description
	Schema()
	Schema(SpecVersion specVersion)
protected	Schema(String type, String format)
protected	Schema(String type, String format, SpecVersion specVersion)

Method Summary

Modifier and Type	Method and Description
Schema	_const(Object _const)
Schema	_default(T _default)
Schema	_else(Schema _else)
Schema	_enum(List<T> _enum)
Schema	_if(Schema _if)
Schema	$anchor(String $anchor)
Schema	$comment(String $comment)
Schema	$id(String $id)
Schema	$ref(String $ref)
Schema	$schema(String $schema)
Schema	addAllOfItem(Schema allOfItem)
Schema	addAnyOfItem(Schema anyOfItem)
void	addEnumItemObject(T _enumItem)
void	addExample(T example)
void	addExtension(String name, Object value)
Schema	additionalItems(Schema additionalItems)
Schema	additionalProperties(Object additionalProperties)
Schema	addOneOfItem(Schema oneOfItem)
Schema	addPatternProperty(String key, Schema patternPropertiesItem)
Schema	addProperties(String key, Schema property) Deprecated.
Schema	addProperty(String key, Schema property)
Schema	addRequiredItem(String requiredItem)
boolean	addType(String type)
Schema	allOf(List<Schema> allOf)
Schema	anyOf(List<Schema> anyOf)
Schema	booleanSchemaValue(Boolean booleanSchemaValue)
protected T	cast(Object value)
Schema	contains(Schema contains)
Schema	contentEncoding(String contentEncoding)
Schema	contentMediaType(String contentMediaType)
Schema	contentSchema(Schema contentSchema)
Schema	dependentRequired(Map<String,List<String>> dependentRequired)
Schema	dependentSchemas(Map<String,Schema> dependentSchemas)
Schema	deprecated(Boolean deprecated)
Schema	description(String description)
Schema	discriminator(Discriminator discriminator)
boolean	equals(Object o)
Schema	example(Object example)
Schema<T>	examples(List<T> examples)
Schema	exampleSetFlag(boolean exampleSetFlag)
Schema	exclusiveMaximum(Boolean exclusiveMaximum)
Schema	exclusiveMaximumValue(BigDecimal exclusiveMaximumValue)
Schema	exclusiveMinimum(Boolean exclusiveMinimum)
Schema	exclusiveMinimumValue(BigDecimal exclusiveMinimumValue)
Schema	extensions(Map<String,Object> extensions)
Schema	externalDocs(ExternalDocumentation externalDocs)
Schema	format(String format)
String	get$anchor()
String	get$comment()
String	get$id()
String	get$ref() returns the $ref property from a Schema instance.
String	get$schema()
Schema	getAdditionalItems()
Object	getAdditionalProperties() returns the additionalProperties property from a Schema instance.
List<Schema>	getAllOf() returns the allOf property from a ComposedSchema instance.
List<Schema>	getAnyOf() returns the anyOf property from a ComposedSchema instance.
Boolean	getBooleanSchemaValue()
T	getConst()
Schema	getContains()
String	getContentEncoding()
String	getContentMediaType()
Schema	getContentSchema()
T	getDefault() returns the _default property from a Schema instance.
Map<String,List<String>>	getDependentRequired()
Map<String,Schema>	getDependentSchemas()
Boolean	getDeprecated() returns the deprecated property from a Schema instance.
String	getDescription() returns the description property from a Schema instance.
Discriminator	getDiscriminator() returns the discriminator property from a AllOfSchema instance.
Schema	getElse()
List<T>	getEnum()
Object	getExample() returns the example property from a Schema instance.
List<T>	getExamples()
boolean	getExampleSetFlag() returns true if example setter has been invoked Used to flag explicit setting to null of example (vs missing field) while deserializing from json/yaml string
Boolean	getExclusiveMaximum() returns the exclusiveMaximum property from a Schema instance for OpenAPI 3.0.x
BigDecimal	getExclusiveMaximumValue() returns the exclusiveMaximumValue property from a Schema instance for OpenAPI 3.1.x
Boolean	getExclusiveMinimum() returns the exclusiveMinimum property from a Schema instance for OpenAPI 3.0.x
BigDecimal	getExclusiveMinimumValue() returns the exclusiveMinimumValue property from a Schema instance for OpenAPI 3.1.x
Map<String,Object>	getExtensions()
ExternalDocumentation	getExternalDocs() returns the externalDocs property from a Schema instance.
String	getFormat() returns the format property from a Schema instance.
Schema	getIf()
Schema<?>	getItems() returns the items property from a ArraySchema instance.
Map<String,Object>	getJsonSchema()
Object	getJsonSchemaImpl()
Integer	getMaxContains()
BigDecimal	getMaximum() returns the maximum property from a Schema instance.
Integer	getMaxItems() returns the maxItems property from a Schema instance.
Integer	getMaxLength() returns the maxLength property from a Schema instance.
Integer	getMaxProperties() returns the maxProperties property from a Schema instance.
Integer	getMinContains()
BigDecimal	getMinimum() returns the minimum property from a Schema instance.
Integer	getMinItems() returns the minItems property from a Schema instance.
Integer	getMinLength() returns the minLength property from a Schema instance.
Integer	getMinProperties() returns the minProperties property from a Schema instance.
BigDecimal	getMultipleOf() returns the multipleOf property from a Schema instance.
String	getName() returns the name property from a from a Schema instance.
Schema	getNot() returns the not property from a Schema instance.
Boolean	getNullable() returns the nullable property from a Schema instance.
List<Schema>	getOneOf() returns the oneOf property from a ComposedSchema instance.
String	getPattern() returns the pattern property from a Schema instance.
Map<String,Schema>	getPatternProperties() returns the patternProperties property from a Schema instance.
List<Schema>	getPrefixItems()
Map<String,Schema>	getProperties() returns the properties property from a Schema instance.
Schema	getPropertyNames()
Boolean	getReadOnly() returns the readOnly property from a Schema instance.
List<String>	getRequired() returns the required property from a Schema instance.
SpecVersion	getSpecVersion()
Schema	getThen()
String	getTitle() returns the title property from a Schema instance.
String	getType() returns the type property from a Schema instance.
Set<String>	getTypes()
Schema	getUnevaluatedItems()
Schema	getUnevaluatedProperties()
Boolean	getUniqueItems() returns the uniqueItems property from a Schema instance.
Boolean	getWriteOnly() returns the writeOnly property from a Schema instance.
XML	getXml() returns the xml property from a Schema instance.
int	hashCode()
Schema	items(Schema<?> items)
Schema	jsonSchema(Map<String,Object> jsonSchema)
Schema	jsonSchemaImpl(Object jsonSchemaImpl)
Schema	maxContains(Integer maxContains)
Schema	maximum(BigDecimal maximum)
Schema	maxItems(Integer maxItems)
Schema	maxLength(Integer maxLength)
Schema	maxProperties(Integer maxProperties)
Schema	minContains(Integer minContains)
Schema	minimum(BigDecimal minimum)
Schema	minItems(Integer minItems)
Schema	minLength(Integer minLength)
Schema	minProperties(Integer minProperties)
Schema	multipleOf(BigDecimal multipleOf)
Schema	name(String name)
Schema	not(Schema not)
Schema	nullable(Boolean nullable)
Schema	oneOf(List<Schema> oneOf)
Schema	pattern(String pattern)
Schema	patternProperties(Map<String,Schema> patternProperties)
Schema	prefixItems(List<Schema> prefixItems)
Schema	properties(Map<String,Schema> properties)
Schema	propertyNames(Schema propertyNames)
Schema	raw$ref(String $ref)
Schema	readOnly(Boolean readOnly)
Schema	required(List<String> required)
void	set$anchor(String $anchor)
void	set$comment(String $comment)
void	set$id(String $id)
void	set$ref(String $ref)
void	set$schema(String $schema)
void	setAdditionalItems(Schema additionalItems)
void	setAdditionalProperties(Object additionalProperties)
void	setAllOf(List<Schema> allOf)
void	setAnyOf(List<Schema> anyOf)
void	setBooleanSchemaValue(Boolean booleanSchemaValue)
void	setConst(Object _const)
void	setContains(Schema contains)
void	setContentEncoding(String contentEncoding)
void	setContentMediaType(String contentMediaType)
void	setContentSchema(Schema contentSchema)
void	setDefault(Object _default)
void	setDependentRequired(Map<String,List<String>> dependentRequired)
void	setDependentSchemas(Map<String,Schema> dependentSchemas)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setDiscriminator(Discriminator discriminator)
void	setElse(Schema _else)
void	setEnum(List<T> _enum)
void	setExample(Object example)
void	setExamples(List<T> examples)
void	setExampleSetFlag(boolean exampleSetFlag)
void	setExclusiveMaximum(Boolean exclusiveMaximum)
void	setExclusiveMaximumValue(BigDecimal exclusiveMaximumValue)
void	setExclusiveMinimum(Boolean exclusiveMinimum)
void	setExclusiveMinimumValue(BigDecimal exclusiveMinimumValue)
void	setExtensions(Map<String,Object> extensions)
void	setExternalDocs(ExternalDocumentation externalDocs)
void	setFormat(String format)
void	setIf(Schema _if)
void	setItems(Schema<?> items)
void	setJsonSchema(Map<String,Object> jsonSchema)
void	setJsonSchemaImpl(Object jsonSchemaImpl)
void	setMaxContains(Integer maxContains)
void	setMaximum(BigDecimal maximum)
void	setMaxItems(Integer maxItems)
void	setMaxLength(Integer maxLength)
void	setMaxProperties(Integer maxProperties)
void	setMinContains(Integer minContains)
void	setMinimum(BigDecimal minimum)
void	setMinItems(Integer minItems)
void	setMinLength(Integer minLength)
void	setMinProperties(Integer minProperties)
void	setMultipleOf(BigDecimal multipleOf)
void	setName(String name)
void	setNot(Schema not)
void	setNullable(Boolean nullable)
void	setOneOf(List<Schema> oneOf)
void	setPattern(String pattern)
void	setPatternProperties(Map<String,Schema> patternProperties)
void	setPrefixItems(List<Schema> prefixItems)
void	setProperties(Map<String,Schema> properties)
void	setPropertyNames(Schema propertyNames)
void	setReadOnly(Boolean readOnly)
void	setRequired(List<String> required)
void	setSpecVersion(SpecVersion specVersion)
void	setThen(Schema then)
void	setTitle(String title)
void	setType(String type)
void	setTypes(Set<String> types)
void	setUnevaluatedItems(Schema unevaluatedItems)
void	setUnevaluatedProperties(Schema unevaluatedProperties)
void	setUniqueItems(Boolean uniqueItems)
void	setWriteOnly(Boolean writeOnly)
void	setXml(XML xml)
Schema	specVersion(SpecVersion specVersion)
Schema	then(Schema then)
Schema	title(String title)
protected String	toIndentedString(Object o) Convert the given object to string with each line indented by 4 spaces (except the first line).
String	toString()
Schema	type(String type)
Schema	types(Set<String> types)
Schema	unevaluatedItems(Schema unevaluatedItems)
Schema	unevaluatedProperties(Schema unevaluatedProperties)
Schema	uniqueItems(Boolean uniqueItems)
Schema	writeOnly(Boolean writeOnly)
Schema	xml(XML xml)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BIND_TYPE_AND_TYPES

public static final String BIND_TYPE_AND_TYPES

See Also:

Constant Field Values

_default

protected T _default

example

protected T example

_enum

protected List<T> _enum

_const

protected T _const

jsonSchema

protected Map<String,Object> jsonSchema

Since:

2.2.0 (OpenAPI 3.1.0)

jsonSchemaImpl

protected transient Object jsonSchemaImpl

Since:

2.2.0 (OpenAPI 3.1.0)

Constructor Detail

Schema

public Schema()

Schema

protected Schema(String type,
                 String format)

Schema

public Schema(SpecVersion specVersion)

Schema

protected Schema(String type,
                 String format,
                 SpecVersion specVersion)

Method Detail

getSpecVersion

public SpecVersion getSpecVersion()

setSpecVersion

public void setSpecVersion(SpecVersion specVersion)

specVersion

public Schema specVersion(SpecVersion specVersion)

getContains

public Schema getContains()

Since:

2.2.0 (OpenAPI 3.1.0)

setContains

public void setContains(Schema contains)

Since:

2.2.0 (OpenAPI 3.1.0)

get$id

public String get$id()

Since:

2.2.0 (OpenAPI 3.1.0)

set$id

public void set$id(String $id)

Since:

2.2.0 (OpenAPI 3.1.0)

get$schema

public String get$schema()

Since:

2.2.0 (OpenAPI 3.1.0)

set$schema

public void set$schema(String $schema)

Since:

2.2.0 (OpenAPI 3.1.0)

get$anchor

public String get$anchor()

Since:

2.2.0 (OpenAPI 3.1.0)

set$anchor

public void set$anchor(String $anchor)

Since:

2.2.0 (OpenAPI 3.1.0)

getExclusiveMaximumValue

public BigDecimal getExclusiveMaximumValue()

returns the exclusiveMaximumValue property from a Schema instance for OpenAPI 3.1.x

Returns:

BigDecimal exclusiveMaximumValue

Since:

2.2.0 (OpenAPI 3.1.0)

setExclusiveMaximumValue

public void setExclusiveMaximumValue(BigDecimal exclusiveMaximumValue)

Since:

2.2.0 (OpenAPI 3.1.0)

exclusiveMaximumValue

public Schema exclusiveMaximumValue(BigDecimal exclusiveMaximumValue)

Since:

2.2.0 (OpenAPI 3.1.0)

getExclusiveMinimumValue

public BigDecimal getExclusiveMinimumValue()

returns the exclusiveMinimumValue property from a Schema instance for OpenAPI 3.1.x

Returns:

BigDecimal exclusiveMinimumValue

Since:

2.2.0 (OpenAPI 3.1.0)

setExclusiveMinimumValue

public void setExclusiveMinimumValue(BigDecimal exclusiveMinimumValue)

Since:

2.2.0 (OpenAPI 3.1.0)

exclusiveMinimumValue

public Schema exclusiveMinimumValue(BigDecimal exclusiveMinimumValue)

Since:

2.2.0 (OpenAPI 3.1.0)

getPatternProperties

public Map<String,Schema> getPatternProperties()

returns the patternProperties property from a Schema instance.

Returns:

Map<String, Schema> patternProperties

Since:

2.2.0 (OpenAPI 3.1.0)

setPatternProperties

public void setPatternProperties(Map<String,Schema> patternProperties)

Since:

2.2.0 (OpenAPI 3.1.0)

patternProperties

public Schema patternProperties(Map<String,Schema> patternProperties)

Since:

2.2.0 (OpenAPI 3.1.0)

addPatternProperty

public Schema addPatternProperty(String key,
                                 Schema patternPropertiesItem)

Since:

2.2.0 (OpenAPI 3.1.0)

contains

public Schema contains(Schema contains)

Since:

2.2.0 (OpenAPI 3.1.0)

$id

public Schema $id(String $id)

Since:

2.2.0 (OpenAPI 3.1.0)

getTypes

public Set<String> getTypes()

Since:

2.2.0 (OpenAPI 3.1.0)

setTypes

public void setTypes(Set<String> types)

Since:

2.2.0 (OpenAPI 3.1.0)

addType

public boolean addType(String type)

Since:

2.2.0 (OpenAPI 3.1.0)

$schema

public Schema $schema(String $schema)

Since:

2.2.0 (OpenAPI 3.1.0)

$anchor

public Schema $anchor(String $anchor)

Since:

2.2.0 (OpenAPI 3.1.0)

types

public Schema types(Set<String> types)

Since:

2.2.0 (OpenAPI 3.1.0)

getJsonSchema

public Map<String,Object> getJsonSchema()

Since:

2.2.0 (OpenAPI 3.1.0)

setJsonSchema

public void setJsonSchema(Map<String,Object> jsonSchema)

Since:

2.2.0 (OpenAPI 3.1.0)

jsonSchema

public Schema jsonSchema(Map<String,Object> jsonSchema)

Since:

2.2.0 (OpenAPI 3.1.0)

getJsonSchemaImpl

public Object getJsonSchemaImpl()

Since:

2.2.0 (OpenAPI 3.1.0)

setJsonSchemaImpl

public void setJsonSchemaImpl(Object jsonSchemaImpl)

Since:

2.2.0 (OpenAPI 3.1.0)

jsonSchemaImpl

public Schema jsonSchemaImpl(Object jsonSchemaImpl)

Since:

2.2.0 (OpenAPI 3.1.0)

getAllOf

public List<Schema> getAllOf()

returns the allOf property from a ComposedSchema instance.

Returns:

List<Schema> allOf

setAllOf

public void setAllOf(List<Schema> allOf)

allOf

public Schema allOf(List<Schema> allOf)

addAllOfItem

public Schema addAllOfItem(Schema allOfItem)

getAnyOf

public List<Schema> getAnyOf()

returns the anyOf property from a ComposedSchema instance.

Returns:

List<Schema> anyOf

setAnyOf

public void setAnyOf(List<Schema> anyOf)

anyOf

public Schema anyOf(List<Schema> anyOf)

addAnyOfItem

public Schema addAnyOfItem(Schema anyOfItem)

getOneOf

public List<Schema> getOneOf()

returns the oneOf property from a ComposedSchema instance.

Returns:

List<Schema> oneOf

setOneOf

public void setOneOf(List<Schema> oneOf)

oneOf

public Schema oneOf(List<Schema> oneOf)

addOneOfItem

public Schema addOneOfItem(Schema oneOfItem)

getItems

public Schema<?> getItems()

returns the items property from a ArraySchema instance.

Returns:

Schema items

setItems

public void setItems(Schema<?> items)

items

public Schema items(Schema<?> items)

getName

public String getName()

returns the name property from a from a Schema instance. Ignored in serialization.

Returns:

String name

setName

public void setName(String name)

name

public Schema name(String name)

getDiscriminator

public Discriminator getDiscriminator()

returns the discriminator property from a AllOfSchema instance.

Returns:

Discriminator discriminator

setDiscriminator

public void setDiscriminator(Discriminator discriminator)

discriminator

public Schema discriminator(Discriminator discriminator)

getTitle

public String getTitle()

returns the title property from a Schema instance.

Returns:

String title

setTitle

public void setTitle(String title)

title

public Schema title(String title)

getDefault

public T getDefault()

returns the _default property from a Schema instance.

Returns:

String _default

setDefault

public void setDefault(Object _default)

cast

protected T cast(Object value)

getEnum

public List<T> getEnum()

setEnum

public void setEnum(List<T> _enum)

addEnumItemObject

public void addEnumItemObject(T _enumItem)

getMultipleOf

public BigDecimal getMultipleOf()

returns the multipleOf property from a Schema instance.

minimum: 0

Returns:

BigDecimal multipleOf

setMultipleOf

public void setMultipleOf(BigDecimal multipleOf)

multipleOf

public Schema multipleOf(BigDecimal multipleOf)

getMaximum

public BigDecimal getMaximum()

returns the maximum property from a Schema instance.

Returns:

BigDecimal maximum

setMaximum

public void setMaximum(BigDecimal maximum)

maximum

public Schema maximum(BigDecimal maximum)

getExclusiveMaximum

public Boolean getExclusiveMaximum()

returns the exclusiveMaximum property from a Schema instance for OpenAPI 3.0.x

Returns:

Boolean exclusiveMaximum

setExclusiveMaximum

public void setExclusiveMaximum(Boolean exclusiveMaximum)

exclusiveMaximum

public Schema exclusiveMaximum(Boolean exclusiveMaximum)

getMinimum

public BigDecimal getMinimum()

returns the minimum property from a Schema instance.

Returns:

BigDecimal minimum

setMinimum

public void setMinimum(BigDecimal minimum)

minimum

public Schema minimum(BigDecimal minimum)

getExclusiveMinimum

public Boolean getExclusiveMinimum()

returns the exclusiveMinimum property from a Schema instance for OpenAPI 3.0.x

Returns:

Boolean exclusiveMinimum

setExclusiveMinimum

public void setExclusiveMinimum(Boolean exclusiveMinimum)

exclusiveMinimum

public Schema exclusiveMinimum(Boolean exclusiveMinimum)

getMaxLength

public Integer getMaxLength()

returns the maxLength property from a Schema instance.

minimum: 0

Returns:

Integer maxLength

setMaxLength

public void setMaxLength(Integer maxLength)

maxLength

public Schema maxLength(Integer maxLength)

getMinLength

public Integer getMinLength()

returns the minLength property from a Schema instance.

minimum: 0

Returns:

Integer minLength

setMinLength

public void setMinLength(Integer minLength)

minLength

public Schema minLength(Integer minLength)

getPattern

public String getPattern()

returns the pattern property from a Schema instance.

Returns:

String pattern

setPattern

public void setPattern(String pattern)

pattern

public Schema pattern(String pattern)

getMaxItems

public Integer getMaxItems()

returns the maxItems property from a Schema instance.

minimum: 0

Returns:

Integer maxItems

setMaxItems

public void setMaxItems(Integer maxItems)

maxItems

public Schema maxItems(Integer maxItems)

getMinItems

public Integer getMinItems()

returns the minItems property from a Schema instance.

minimum: 0

Returns:

Integer minItems

setMinItems

public void setMinItems(Integer minItems)

minItems

public Schema minItems(Integer minItems)

getUniqueItems

public Boolean getUniqueItems()

returns the uniqueItems property from a Schema instance.

Returns:

Boolean uniqueItems

setUniqueItems

public void setUniqueItems(Boolean uniqueItems)

uniqueItems

public Schema uniqueItems(Boolean uniqueItems)

getMaxProperties

public Integer getMaxProperties()

returns the maxProperties property from a Schema instance.

minimum: 0

Returns:

Integer maxProperties

setMaxProperties

public void setMaxProperties(Integer maxProperties)

maxProperties

public Schema maxProperties(Integer maxProperties)

getMinProperties

public Integer getMinProperties()

returns the minProperties property from a Schema instance.

minimum: 0

Returns:

Integer minProperties

setMinProperties

public void setMinProperties(Integer minProperties)

minProperties

public Schema minProperties(Integer minProperties)

getRequired

public List<String> getRequired()

returns the required property from a Schema instance.

Returns:

List<String> required

setRequired

public void setRequired(List<String> required)

required

public Schema required(List<String> required)

addRequiredItem

public Schema addRequiredItem(String requiredItem)

getType

public String getType()

returns the type property from a Schema instance.

Returns:

String type

setType

public void setType(String type)

type

public Schema type(String type)

getNot

public Schema getNot()

returns the not property from a Schema instance.

Returns:

Schema not

setNot

public void setNot(Schema not)

not

public Schema not(Schema not)

getProperties

public Map<String,Schema> getProperties()

returns the properties property from a Schema instance.

Returns:

Map<String, Schema> properties

setProperties

public void setProperties(Map<String,Schema> properties)

properties

public Schema properties(Map<String,Schema> properties)

addProperties

@Deprecated
public Schema addProperties(String key,
                                        Schema property)

Deprecated.

addProperty

public Schema addProperty(String key,
                          Schema property)

Since:

2.2.0

getAdditionalProperties

public Object getAdditionalProperties()

returns the additionalProperties property from a Schema instance. Can be either a Boolean or a Schema

Returns:

Object additionalProperties

setAdditionalProperties

public void setAdditionalProperties(Object additionalProperties)

additionalProperties

public Schema additionalProperties(Object additionalProperties)

getDescription

public String getDescription()

returns the description property from a Schema instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Schema description(String description)

getFormat

public String getFormat()

returns the format property from a Schema instance.

Returns:

String format

setFormat

public void setFormat(String format)

format

public Schema format(String format)

get$ref

public String get$ref()

returns the $ref property from a Schema instance.

Returns:

String $ref

set$ref

public void set$ref(String $ref)

$ref

public Schema $ref(String $ref)

raw$ref

public Schema raw$ref(String $ref)

getNullable

public Boolean getNullable()

returns the nullable property from a Schema instance.

Returns:

Boolean nullable

setNullable

public void setNullable(Boolean nullable)

nullable

public Schema nullable(Boolean nullable)

getReadOnly

public Boolean getReadOnly()

returns the readOnly property from a Schema instance.

Returns:

Boolean readOnly

setReadOnly

public void setReadOnly(Boolean readOnly)

readOnly

public Schema readOnly(Boolean readOnly)

getWriteOnly

public Boolean getWriteOnly()

returns the writeOnly property from a Schema instance.

Returns:

Boolean writeOnly

setWriteOnly

public void setWriteOnly(Boolean writeOnly)

writeOnly

public Schema writeOnly(Boolean writeOnly)

getExample

public Object getExample()

returns the example property from a Schema instance.

Returns:

String example

setExample

public void setExample(Object example)

example

public Schema example(Object example)

getExternalDocs

public ExternalDocumentation getExternalDocs()

returns the externalDocs property from a Schema instance.

Returns:

ExternalDocumentation externalDocs

setExternalDocs

public void setExternalDocs(ExternalDocumentation externalDocs)

externalDocs

public Schema externalDocs(ExternalDocumentation externalDocs)

getDeprecated

public Boolean getDeprecated()

returns the deprecated property from a Schema instance.

Returns:

Boolean deprecated

setDeprecated

public void setDeprecated(Boolean deprecated)

deprecated

public Schema deprecated(Boolean deprecated)

getXml

public XML getXml()

returns the xml property from a Schema instance.

Returns:

XML xml

setXml

public void setXml(XML xml)

xml

public Schema xml(XML xml)

getExampleSetFlag

public boolean getExampleSetFlag()

returns true if example setter has been invoked Used to flag explicit setting to null of example (vs missing field) while deserializing from json/yaml string

Returns:

boolean exampleSetFlag

setExampleSetFlag

public void setExampleSetFlag(boolean exampleSetFlag)

getPrefixItems

public List<Schema> getPrefixItems()

Since:

2.2.0 (OpenAPI 3.1.0)

setPrefixItems

public void setPrefixItems(List<Schema> prefixItems)

Since:

2.2.0 (OpenAPI 3.1.0)

prefixItems

public Schema prefixItems(List<Schema> prefixItems)

Since:

2.2.0 (OpenAPI 3.1.0)

getContentEncoding

public String getContentEncoding()

Since:

2.2.0 (OpenAPI 3.1.0)

setContentEncoding

public void setContentEncoding(String contentEncoding)

Since:

2.2.0 (OpenAPI 3.1.0)

contentEncoding

public Schema contentEncoding(String contentEncoding)

Since:

2.2.0 (OpenAPI 3.1.0)

getContentMediaType

public String getContentMediaType()

Since:

2.2.0 (OpenAPI 3.1.0)

setContentMediaType

public void setContentMediaType(String contentMediaType)

Since:

2.2.0 (OpenAPI 3.1.0)

contentMediaType

public Schema contentMediaType(String contentMediaType)

Since:

2.2.0 (OpenAPI 3.1.0)

getContentSchema

public Schema getContentSchema()

Since:

2.2.0 (OpenAPI 3.1.0)

setContentSchema

public void setContentSchema(Schema contentSchema)

Since:

2.2.0 (OpenAPI 3.1.0)

contentSchema

public Schema contentSchema(Schema contentSchema)

Since:

2.2.0 (OpenAPI 3.1.0)

getPropertyNames

public Schema getPropertyNames()

Since:

2.2.0 (OpenAPI 3.1.0)

setPropertyNames

public void setPropertyNames(Schema propertyNames)

Since:

2.2.0 (OpenAPI 3.1.0)

propertyNames

public Schema propertyNames(Schema propertyNames)

Since:

2.2.0 (OpenAPI 3.1.0)

getUnevaluatedProperties

public Schema getUnevaluatedProperties()

Since:

2.2.0 (OpenAPI 3.1.0)

setUnevaluatedProperties

public void setUnevaluatedProperties(Schema unevaluatedProperties)

Since:

2.2.0 (OpenAPI 3.1.0)

unevaluatedProperties

public Schema unevaluatedProperties(Schema unevaluatedProperties)

Since:

2.2.0 (OpenAPI 3.1.0)

getMaxContains

public Integer getMaxContains()

Since:

2.2.0 (OpenAPI 3.1.0)

setMaxContains

public void setMaxContains(Integer maxContains)

Since:

2.2.0 (OpenAPI 3.1.0)

maxContains

public Schema maxContains(Integer maxContains)

Since:

2.2.0 (OpenAPI 3.1.0)

getMinContains

public Integer getMinContains()

Since:

2.2.0 (OpenAPI 3.1.0)

setMinContains

public void setMinContains(Integer minContains)

Since:

2.2.0 (OpenAPI 3.1.0)

minContains

public Schema minContains(Integer minContains)

Since:

2.2.0 (OpenAPI 3.1.0)

getAdditionalItems

public Schema getAdditionalItems()

Since:

2.2.0 (OpenAPI 3.1.0)

setAdditionalItems

public void setAdditionalItems(Schema additionalItems)

Since:

2.2.0 (OpenAPI 3.1.0)

additionalItems

public Schema additionalItems(Schema additionalItems)

Since:

2.2.0 (OpenAPI 3.1.0)

getUnevaluatedItems

public Schema getUnevaluatedItems()

Since:

2.2.0 (OpenAPI 3.1.0)

setUnevaluatedItems

public void setUnevaluatedItems(Schema unevaluatedItems)

Since:

2.2.0 (OpenAPI 3.1.0)

unevaluatedItems

public Schema unevaluatedItems(Schema unevaluatedItems)

Since:

2.2.0 (OpenAPI 3.1.0)

getIf

public Schema getIf()

Since:

2.2.0 (OpenAPI 3.1.0)

setIf

public void setIf(Schema _if)

Since:

2.2.0 (OpenAPI 3.1.0)

_if

public Schema _if(Schema _if)

Since:

2.2.0 (OpenAPI 3.1.0)

getElse

public Schema getElse()

Since:

2.2.0 (OpenAPI 3.1.0)

setElse

public void setElse(Schema _else)

Since:

2.2.0 (OpenAPI 3.1.0)

_else

public Schema _else(Schema _else)

Since:

2.2.0 (OpenAPI 3.1.0)

getThen

public Schema getThen()

Since:

2.2.0 (OpenAPI 3.1.0)

setThen

public void setThen(Schema then)

Since:

2.2.0 (OpenAPI 3.1.0)

then

public Schema then(Schema then)

Since:

2.2.0 (OpenAPI 3.1.0)

getDependentSchemas

public Map<String,Schema> getDependentSchemas()

Since:

2.2.0 (OpenAPI 3.1.0)

setDependentSchemas

public void setDependentSchemas(Map<String,Schema> dependentSchemas)

Since:

2.2.0 (OpenAPI 3.1.0)

dependentSchemas

public Schema dependentSchemas(Map<String,Schema> dependentSchemas)

Since:

2.2.0 (OpenAPI 3.1.0)

getDependentRequired

public Map<String,List<String>> getDependentRequired()

Since:

2.2.0 (OpenAPI 3.1.0)

setDependentRequired

public void setDependentRequired(Map<String,List<String>> dependentRequired)

Since:

2.2.0 (OpenAPI 3.1.0)

dependentRequired

public Schema dependentRequired(Map<String,List<String>> dependentRequired)

Since:

2.2.0 (OpenAPI 3.1.0)

get$comment

public String get$comment()

Since:

2.2.0 (OpenAPI 3.1.0)

set$comment

public void set$comment(String $comment)

Since:

2.2.0 (OpenAPI 3.1.0)

$comment

public Schema $comment(String $comment)

Since:

2.2.0 (OpenAPI 3.1.0)

getExamples

public List<T> getExamples()

Since:

2.2.0 (OpenAPI 3.1.0)

setExamples

public void setExamples(List<T> examples)

Since:

2.2.0 (OpenAPI 3.1.0)

examples

public Schema<T> examples(List<T> examples)

Since:

2.2.0 (OpenAPI 3.1.0)

addExample

public void addExample(T example)

Since:

2.2.0 (OpenAPI 3.1.0)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public Schema extensions(Map<String,Object> extensions)

toString

public String toString()

Overrides:

toString in class Object

toIndentedString

protected String toIndentedString(Object o)

Convert the given object to string with each line indented by 4 spaces (except the first line).

_default

public Schema _default(T _default)

_enum

public Schema _enum(List<T> _enum)

exampleSetFlag

public Schema exampleSetFlag(boolean exampleSetFlag)

getConst

public T getConst()

Since:

2.2.0 (OpenAPI 3.1.0)

setConst

public void setConst(Object _const)

Since:

2.2.0 (OpenAPI 3.1.0)

_const

public Schema _const(Object _const)

Since:

2.2.0 (OpenAPI 3.1.0)

getBooleanSchemaValue

public Boolean getBooleanSchemaValue()

Since:

2.2.2 (OpenAPI 3.1.0)

setBooleanSchemaValue

public void setBooleanSchemaValue(Boolean booleanSchemaValue)

Since:

2.2.2 (OpenAPI 3.1.0)

booleanSchemaValue

public Schema booleanSchemaValue(Boolean booleanSchemaValue)

Since:

2.2.2 (OpenAPI 3.1.0)