# Uses of Interface
org.eclipse.microprofile.openapi.models.media.Schema

Packages that use Schema
Package
Description
org.eclipse.microprofile.openapi
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3 documents from their JAX-RS applications.
org.eclipse.microprofile.openapi.models
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
org.eclipse.microprofile.openapi.models.headers
An interface of a programmable model to represent a single header object.
org.eclipse.microprofile.openapi.models.media
A set of interfaces for programmable models to represent input and output data types and media types.
org.eclipse.microprofile.openapi.models.parameters
A set of model interfaces to describe operation parameters and operation's request body.

## Uses of Schema in org.eclipse.microprofile.openapi

Methods in org.eclipse.microprofile.openapi that return Schema
Modifier and Type
Method
Description
`static Schema`
OASFactory.`createSchema()`
This method creates a new `Schema` instance.
`default Schema`
OASFilter.`filterSchema(Schema schema)`
Allows filtering of a particular Schema.
Methods in org.eclipse.microprofile.openapi with parameters of type Schema
Modifier and Type
Method
Description
`default Schema`
OASFilter.`filterSchema(Schema schema)`
Allows filtering of a particular Schema.

## Uses of Schema in org.eclipse.microprofile.openapi.models

Methods in org.eclipse.microprofile.openapi.models that return types with arguments of type Schema
Modifier and Type
Method
Description
`Map<String,Schema>`
Components.`getSchemas()`
Returns the schemas property from a Components instance.
Methods in org.eclipse.microprofile.openapi.models with parameters of type Schema
Modifier and Type
Method
Description
`Components`
Components.`addSchema(String key, Schema schema)`
Adds the given schema to this Components' list of schemas with the given string as its key.
Method parameters in org.eclipse.microprofile.openapi.models with type arguments of type Schema
Modifier and Type
Method
Description
`default Components`
Components.`schemas(Map<String,Schema> schemas)`
Sets this Components' schemas property to the given Map containing keys and reusable schemas.
`void`
Components.`setSchemas(Map<String,Schema> schemas)`
Sets this Components' schemas property to the given Map containing keys and reusable schema objects.

## Uses of Schema in org.eclipse.microprofile.openapi.models.headers

Methods in org.eclipse.microprofile.openapi.models.headers that return Schema
Modifier and Type
Method
Description
`Schema`
Header.`getSchema()`
Returns the schema property from a Header instance.
Methods in org.eclipse.microprofile.openapi.models.headers with parameters of type Schema
Modifier and Type
Method
Description
`default Header`
Header.`schema(Schema schema)`
Sets this Header's schema property to the given object.
`void`
Header.`setSchema(Schema schema)`
Sets this Header's schema property to the given object.

## Uses of Schema in org.eclipse.microprofile.openapi.models.media

Methods in org.eclipse.microprofile.openapi.models.media that return Schema
Modifier and Type
Method
Description
`Schema`
Schema.`addAllOf(Schema allOf)`
Adds the given Schema to the list of schemas used by the allOf property.
`Schema`
Schema.`addAnyOf(Schema anyOf)`
Adds the given Schema to the list of schemas used by the anyOf property.
`Schema`
Schema.`addEnumeration(Object enumeration)`
Adds an item of the appropriate type to the enumerated list of values allowed.
`default Schema`
Schema.`additionalPropertiesBoolean(Boolean additionalProperties)`
Sets the value of "additionalProperties" to either True or False.
`default Schema`
Schema.`additionalPropertiesSchema(Schema additionalProperties)`
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
`Schema`
Schema.`addOneOf(Schema oneOf)`
Adds the given Schema to the list of schemas used by the oneOf property.
`Schema`
Schema.`addProperty(String key, Schema propertySchema)`
Adds a Schema property of the provided name using the given schema.
`Schema`
Schema.`addRequired(String required)`
Adds the name of an item to the list of fields required in objects defined by this Schema.
`default Schema`
Schema.`allOf(List<Schema> allOf)`
Sets the schemas used by the allOf property of this Schema.
`default Schema`
Schema.`anyOf(List<Schema> anyOf)`
Sets the schemas used by the anyOf property of this Schema.
`default Schema`
Schema.`defaultValue(Object defaultValue)`
Set the default value property of this Schema instance to the value given.
`default Schema`
Schema.`deprecated(Boolean deprecated)`
Sets the deprecated property of this Schema.
`default Schema`
Schema.`description(String description)`
Sets the description property of this Schema to the given string.
`default Schema`
Schema.`discriminator(Discriminator discriminator)`
Sets the discriminator property of this Schema instance to the given object.
`default Schema`
Schema.`enumeration(List<Object> enumeration)`
`default Schema`
Schema.`example(Object example)`
Sets the example property of this Schema instance.
`default Schema`
Schema.`exclusiveMaximum(Boolean exclusiveMaximum)`
Sets the exclusiveMaximum property of this Schema instance to the value given.
`default Schema`
Schema.`exclusiveMinimum(Boolean exclusiveMinimum)`
Sets the exclusiveMinimum property of this Schema instance to the value given.
`default Schema`
Schema.`externalDocs(ExternalDocumentation externalDocs)`
Sets the externalDocs property of this Schema to the indicated value.
`default Schema`
Schema.`format(String format)`
Sets the format property of this Schema instance to the given string.
`Schema`
Schema.`getAdditionalPropertiesSchema()`
Returns the value of the "additionalProperties" setting, which indicates whether properties not otherwise defined are allowed.
`Schema`
Schema.`getItems()`
Returns the Schema used for all the elements of an array typed Schema.
`Schema`
Schema.`getNot()`
Returns a Schema which describes properties not allowed in objects defined by the current schema.
`Schema`
MediaType.`getSchema()`
Returns the schema property from a MediaType instance.
`default Schema`
Schema.`items(Schema items)`
Set the Schema used for all the elements of an array typed Schema.
`default Schema`
Schema.`maximum(BigDecimal maximum)`
Sets the maximum property of this Schema instance to the value given.
`default Schema`
Schema.`maxItems(Integer maxItems)`
Sets the maxItems property of this Schema instance to the value given.
`default Schema`
Schema.`maxLength(Integer maxLength)`
Sets the maxLength property of this Schema instance to the value given.
`default Schema`
Schema.`maxProperties(Integer maxProperties)`
Sets the maxProperties property of this Schema instance to the value given.
`default Schema`
Schema.`minimum(BigDecimal minimum)`
Sets the minimum property of this Schema instance to the value given.
`default Schema`
Schema.`minItems(Integer minItems)`
Sets the minItems property of this Schema instance to the value given.
`default Schema`
Schema.`minLength(Integer minLength)`
Sets the minLength property of this Schema instance to the value given.
`default Schema`
Schema.`minProperties(Integer minProperties)`
Sets the minProperties property of this Schema instance to the value given.
`default Schema`
Schema.`multipleOf(BigDecimal multipleOf)`
Sets the multipleOf property of this Schema instance to the value given.
`default Schema`
Schema.`not(Schema not)`
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
`default Schema`
Schema.`nullable(Boolean nullable)`
Sets the nullable property of this Schema instance.
`default Schema`
Schema.`oneOf(List<Schema> oneOf)`
Sets the schemas used by the oneOf property of this Schema.
`default Schema`
Schema.`pattern(String pattern)`
Sets the pattern property of this Schema instance to the string given.
`default Schema`
Schema.`properties(Map<String,Schema> properties)`
Sets the properties of this Schema instance to the map provided.
`default Schema`
Schema.`readOnly(Boolean readOnly)`
Sets the readOnly property of this Schema.
`default Schema`
Schema.`required(List<String> required)`
Sets the list of fields required in objects defined by this Schema.
`default Schema`
Schema.`title(String title)`
Sets the title property of this Schema instance to the given string.
`default Schema`
Schema.`type(Schema.SchemaType type)`
Sets the type used by this Schema to the string given.
`default Schema`
Schema.`uniqueItems(Boolean uniqueItems)`
Sets the uniqueItems property of this Schema instance to the value given.
`default Schema`
Schema.`writeOnly(Boolean writeOnly)`
Sets the writeOnly property of this Schema.
`default Schema`
Schema.`xml(XML xml)`
Sets the xml property of this Schema instance.
Methods in org.eclipse.microprofile.openapi.models.media that return types with arguments of type Schema
Modifier and Type
Method
Description
`List<Schema>`
Schema.`getAllOf()`
Returns the schemas used by the allOf property.
`List<Schema>`
Schema.`getAnyOf()`
Returns the schemas used by the anyOf property.
`List<Schema>`
Schema.`getOneOf()`
Returns the schemas used by the oneOf property.
`Map<String,Schema>`
Schema.`getProperties()`
Returns the properties defined in this Schema.
Methods in org.eclipse.microprofile.openapi.models.media with parameters of type Schema
Modifier and Type
Method
Description
`Schema`
Schema.`addAllOf(Schema allOf)`
Adds the given Schema to the list of schemas used by the allOf property.
`Schema`
Schema.`addAnyOf(Schema anyOf)`
Adds the given Schema to the list of schemas used by the anyOf property.
`default Schema`
Schema.`additionalPropertiesSchema(Schema additionalProperties)`
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
`Schema`
Schema.`addOneOf(Schema oneOf)`
Adds the given Schema to the list of schemas used by the oneOf property.
`Schema`
Schema.`addProperty(String key, Schema propertySchema)`
Adds a Schema property of the provided name using the given schema.
`default Schema`
Schema.`items(Schema items)`
Set the Schema used for all the elements of an array typed Schema.
`default Schema`
Schema.`not(Schema not)`
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
`void`
Schema.`removeAllOf(Schema allOf)`
Removes the given Schema to the list of schemas used by the allOf property.
`void`
Schema.`removeAnyOf(Schema anyOf)`
Removes the given Schema to the list of schemas used by the anyOf property.
`void`
Schema.`removeOneOf(Schema oneOf)`
Removes the given Schema to the list of schemas used by the oneOf property.
`default MediaType`
MediaType.`schema(Schema schema)`
Sets the schema field of a MediaType instance to the given schema object.
`void`
Schema.`setAdditionalPropertiesSchema(Schema additionalProperties)`
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
`void`
Schema.`setItems(Schema items)`
Set the Schema used for all the elements of an array typed Schema.
`void`
Schema.`setNot(Schema not)`
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
`void`
MediaType.`setSchema(Schema schema)`
Sets the schema field of a MediaType instance to the given schema object.
Method parameters in org.eclipse.microprofile.openapi.models.media with type arguments of type Schema
Modifier and Type
Method
Description
`default Schema`
Schema.`allOf(List<Schema> allOf)`
Sets the schemas used by the allOf property of this Schema.
`default Schema`
Schema.`anyOf(List<Schema> anyOf)`
Sets the schemas used by the anyOf property of this Schema.
`default Schema`
Schema.`oneOf(List<Schema> oneOf)`
Sets the schemas used by the oneOf property of this Schema.
`default Schema`
Schema.`properties(Map<String,Schema> properties)`
Sets the properties of this Schema instance to the map provided.
`void`
Schema.`setAllOf(List<Schema> allOf)`
Sets the schemas used by the allOf property of this Schema.
`void`
Schema.`setAnyOf(List<Schema> anyOf)`
Sets the schemas used by the anyOf property of this Schema.
`void`
Schema.`setOneOf(List<Schema> oneOf)`
Sets the schemas used by the oneOf property of this Schema.
`void`
Schema.`setProperties(Map<String,Schema> properties)`
Sets the properties of this Schema instance to the map provided.

## Uses of Schema in org.eclipse.microprofile.openapi.models.parameters

Methods in org.eclipse.microprofile.openapi.models.parameters that return Schema
Modifier and Type
Method
Description
`Schema`
Parameter.`getSchema()`
Returns the schema property from a Parameter instance.
Methods in org.eclipse.microprofile.openapi.models.parameters with parameters of type Schema
Modifier and Type
Method
Description
`default Parameter`
Parameter.`schema(Schema schema)`
Sets the schema property of a Parameter instance to the given value.
`void`
Parameter.`setSchema(Schema schema)`
Sets the schema property of a Parameter instance to the given value.