io.apicurio.datamodels.openapi.v3.models

Class Oas30Schema

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.common.Schema

io.apicurio.datamodels.openapi.models.OasSchema

io.apicurio.datamodels.openapi.v3.models.Oas30Schema

All Implemented Interfaces:

IExternalDocumentationParent, IReferenceNode, IVisitable

Direct Known Subclasses:

Oas30Schema.Oas30AdditionalPropertiesSchema, Oas30Schema.Oas30AllOfSchema, Oas30Schema.Oas30AnyOfSchema, Oas30Schema.Oas30ItemsSchema, Oas30Schema.Oas30NotSchema, Oas30Schema.Oas30OneOfSchema, Oas30Schema.Oas30PropertySchema, Oas30SchemaDefinition

public class Oas30Schema
extends OasSchema

Models an OpenAPI 3.0.x schema.

Author:

eric.wittmann@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Oas30Schema.Oas30AdditionalPropertiesSchema
static class	Oas30Schema.Oas30AllOfSchema
static class	Oas30Schema.Oas30AnyOfSchema
static class	Oas30Schema.Oas30ItemsSchema
static class	Oas30Schema.Oas30NotSchema
static class	Oas30Schema.Oas30OneOfSchema
static class	Oas30Schema.Oas30PropertySchema

Field Summary

Fields

Modifier and Type	Field and Description
List<OasSchema>	anyOf
Boolean	deprecated
Oas30Discriminator	discriminator
OasSchema	not
Boolean	nullable
List<OasSchema>	oneOf
Boolean	writeOnly

Fields inherited from class io.apicurio.datamodels.openapi.models.OasSchema

additionalProperties, allOf, default_, description, enum_, example, exclusiveMaximum, exclusiveMinimum, externalDocs, format, items, maximum, maxItems, maxLength, maxProperties, minimum, minItems, minLength, minProperties, multipleOf, pattern, properties, readOnly, required, title, type, uniqueItems, xml

Fields inherited from class io.apicurio.datamodels.core.models.common.Schema

$ref

Fields inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

_extensions

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas30Schema()

Method Summary

Modifier and Type	Method and Description
void	addAnyOfSchema(Oas30Schema.Oas30AnyOfSchema schema) Adds an AnyOf schema.
void	addOneOfSchema(Oas30Schema.Oas30OneOfSchema schema) Adds a OneOf schema.
OasSchema	createAdditionalPropertiesSchema() Creates a child schema model.
OasSchema	createAllOfSchema() Creates a child schema model.
Oas30Schema.Oas30AnyOfSchema	createAnyOfSchema() Creates a child schema model.
Oas30Discriminator	createDiscriminator() Creates a child Discriminator model.
ExternalDocumentation	createExternalDocumentation() Creates a child external documentation model.
OasSchema	createItemsSchema() Creates a child schema model.
Oas30Schema.Oas30NotSchema	createNotSchema() Creates a child schema model.
Oas30Schema.Oas30OneOfSchema	createOneOfSchema() Creates a child schema model.
OasSchema	createPropertySchema(String propertyName) Creates a child schema model.
OasXML	createXML() Creates a child XML model.
void	removeAnyOfSchema(Oas30Schema.Oas30AnyOfSchema schema) Removes a anyOf schema.
void	removeOneOfSchema(Oas30Schema.Oas30OneOfSchema schema) Removes a oneOf schema.

Methods inherited from class io.apicurio.datamodels.openapi.models.OasSchema

addAllOfSchema, addProperty, getProperties, getProperty, getPropertyNames, hasAdditionalPropertiesBoolean, hasAdditionalPropertiesSchema, hasItemsSchema, hasItemsSchemas, removeAllOfSchema, removeProperty, setExternalDocumentation

Methods inherited from class io.apicurio.datamodels.core.models.common.Schema

accept

Methods inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension

Methods inherited from class io.apicurio.datamodels.core.models.Node

addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

oneOf

public List<OasSchema> oneOf

anyOf

public List<OasSchema> anyOf

not

public OasSchema not

discriminator

public Oas30Discriminator discriminator

nullable

public Boolean nullable

writeOnly

public Boolean writeOnly

deprecated

public Boolean deprecated

Constructor Detail

Oas30Schema

public Oas30Schema()

Method Detail

createDiscriminator

public Oas30Discriminator createDiscriminator()

Creates a child Discriminator model.

Returns:

{Oas30Discriminator}

createExternalDocumentation

public ExternalDocumentation createExternalDocumentation()

Description copied from class: OasSchema

Creates a child external documentation model.

Specified by:

createExternalDocumentation in interface IExternalDocumentationParent

Specified by:

createExternalDocumentation in class OasSchema

See Also:

OasSchema.createExternalDocumentation()

createXML

public OasXML createXML()

Description copied from class: OasSchema

Creates a child XML model.

Specified by:

createXML in class OasSchema

See Also:

OasSchema.createXML()

createAllOfSchema

public OasSchema createAllOfSchema()

Description copied from class: OasSchema

Creates a child schema model.

Specified by:

createAllOfSchema in class OasSchema

See Also:

OasSchema.createAllOfSchema()

createItemsSchema

public OasSchema createItemsSchema()

Description copied from class: OasSchema

Creates a child schema model.

Specified by:

createItemsSchema in class OasSchema

See Also:

OasSchema.createItemsSchema()

createAdditionalPropertiesSchema

public OasSchema createAdditionalPropertiesSchema()

Description copied from class: OasSchema

Creates a child schema model.

Specified by:

createAdditionalPropertiesSchema in class OasSchema

See Also:

OasSchema.createAdditionalPropertiesSchema()

createPropertySchema

public OasSchema createPropertySchema(String propertyName)

Description copied from class: OasSchema

Creates a child schema model.

Specified by:

createPropertySchema in class OasSchema

See Also:

OasSchema.createPropertySchema(java.lang.String)

createOneOfSchema

public Oas30Schema.Oas30OneOfSchema createOneOfSchema()

Creates a child schema model.

createAnyOfSchema

public Oas30Schema.Oas30AnyOfSchema createAnyOfSchema()

Creates a child schema model.

createNotSchema

public Oas30Schema.Oas30NotSchema createNotSchema()

Creates a child schema model.

addOneOfSchema

public void addOneOfSchema(Oas30Schema.Oas30OneOfSchema schema)

Adds a OneOf schema.

Parameters:

schema -

addAnyOfSchema

public void addAnyOfSchema(Oas30Schema.Oas30AnyOfSchema schema)

Adds an AnyOf schema.

Parameters:

schema -

removeOneOfSchema

public void removeOneOfSchema(Oas30Schema.Oas30OneOfSchema schema)

Removes a oneOf schema.

Parameters:

schema -

removeAnyOfSchema

public void removeAnyOfSchema(Oas30Schema.Oas30AnyOfSchema schema)

Removes a anyOf schema.

Parameters:

schema -