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.1 documents from their Jakarta REST 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 newSchema
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. addDependentRequired(String propertyName, List<String> additionalRequiredPropertyNames)
Sets the list of additional property names that are required if a property namedpropertyName
exists.Schema
Schema. addDependentSchema(String propertyName, Schema schema)
Sets the dependent schema for a property name.Schema
Schema. addEnumeration(Object enumeration)
Adds an item of the appropriate type to the enumerated list of values allowed.Schema
Schema. addExample(Object example)
Adds an example to the examples list.default Schema
Schema. additionalPropertiesBoolean(Boolean additionalProperties)
Deprecated.useadditionalPropertiesSchema(Schema)
with a boolean-valued schemadefault 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. addPatternProperty(String regularExpression, Schema schema)
Adds a regular expression and schema pair to the list of pattern properties.Schema
Schema. addPrefixItem(Schema prefixItem)
Adds a schema to the end of the prefixItems list.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.Schema
Schema. addType(Schema.SchemaType type)
Adds a type to the type list.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. booleanSchema(Boolean booleanSchema)
Sets this schema to a boolean value.default Schema
Schema. comment(String comment)
Sets the comment to be included in the$comment
property of the schema.default Schema
Schema. constValue(Object constValue)
Sets the const property from this Schema instance.default Schema
Schema. contains(Schema contains)
Sets the contains property of this Schema instance.default Schema
Schema. contentEncoding(String contentEncoding)
Sets the contentEncoding property from this Schema instance.default Schema
Schema. contentMediaType(String contentMediaType)
Sets the contentMediaType property from this Schema instance.default Schema
Schema. contentSchema(Schema contentSchema)
Sets the contentSchema property from this Schema instance.default Schema
Schema. defaultValue(Object defaultValue)
Set the default value property of this Schema instance to the value given.default Schema
Schema. dependentRequired(Map<String,List<String>> dependentRequired)
Sets the dependentRequired property of this Schema instance.default Schema
Schema. dependentSchemas(Map<String,Schema> dependentSchemas)
Sets the dependentSchemas property of this Schema instance.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. elseSchema(Schema elseSchema)
Sets the "else" schema.default Schema
Schema. enumeration(List<Object> enumeration)
default Schema
Schema. example(Object example)
Deprecated.useexamples(List)
default Schema
Schema. examples(List<Object> examples)
Sets the examples property of this Schema instance.default Schema
Schema. exclusiveMaximum(BigDecimal exclusiveMaximum)
Sets the exclusiveMaximum property of this Schema instance to the value given.default Schema
Schema. exclusiveMinimum(BigDecimal 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. getContains()
Returns the contains property of this Schema instance.Schema
Schema. getContentSchema()
Returns the contentSchema property from this Schema instance.Schema
Schema. getElseSchema()
Returns the "else" schema.Schema
Schema. getIfSchema()
Returns the "if" schema.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
Schema. getPropertyNames()
Returns the propertyNames property from this Schema instance.Schema
MediaType. getSchema()
Returns the schema property from a MediaType instance.Schema
Schema. getThenSchema()
Returns the "then" schema.Schema
Schema. getUnevaluatedItems()
Returns the unevaluatedItems property of this Schema instance.Schema
Schema. getUnevaluatedProperties()
Returns the unevaluatedProperties property of this Schema instance.default Schema
Schema. ifSchema(Schema ifSchema)
Sets the "if" schema.default Schema
Schema. items(Schema items)
Set the Schema used for all the elements of an array typed Schema.default Schema
Schema. maxContains(Integer maxContains)
Sets the maxContains property from this Schema instance.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. minContains(Integer minContains)
Sets the minContains property from this Schema instance.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. 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. patternProperties(Map<String,Schema> patternProperties)
Sets the patternProperties property from this Schema instance.default Schema
Schema. prefixItems(List<Schema> prefixItems)
Sets the prefixItems property of this Schema instance.default Schema
Schema. properties(Map<String,Schema> properties)
Sets the properties of this Schema instance to the map provided.default Schema
Schema. propertyNames(Schema propertyNameSchema)
Sets the propertyNames property from this Schema instance.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. schemaDialect(String schemaDialect)
Sets the schema dialect in use.Schema
Schema. set(String propertyName, Object value)
Sets a schema property.default Schema
Schema. thenSchema(Schema thenSchema)
Sets the "then" schema.default Schema
Schema. title(String title)
Sets the title property of this Schema instance to the given string.default Schema
Schema. type(List<Schema.SchemaType> types)
Sets the type property of this Schema instance.default Schema
Schema. unevaluatedItems(Schema unevaluatedItems)
Sets the unevaluatedItems property of this Schema instance.default Schema
Schema. unevaluatedProperties(Schema unevaluatedProperties)
Sets the unevaluatedProperties property of this Schema instance.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.Map<String,Schema>
Schema. getDependentSchemas()
Returns the dependentSchemas property of this Schema instance.List<Schema>
Schema. getOneOf()
Returns the schemas used by the oneOf property.Map<String,Schema>
Schema. getPatternProperties()
Returns the patternProperties property from this Schema instance.List<Schema>
Schema. getPrefixItems()
Returns the prefixItems property of this Schema instance.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.Schema
Schema. addDependentSchema(String propertyName, Schema schema)
Sets the dependent schema for a property name.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. addPatternProperty(String regularExpression, Schema schema)
Adds a regular expression and schema pair to the list of pattern properties.Schema
Schema. addPrefixItem(Schema prefixItem)
Adds a schema to the end of the prefixItems list.Schema
Schema. addProperty(String key, Schema propertySchema)
Adds a Schema property of the provided name using the given schema.default Schema
Schema. contains(Schema contains)
Sets the contains property of this Schema instance.default Schema
Schema. contentSchema(Schema contentSchema)
Sets the contentSchema property from this Schema instance.default Schema
Schema. elseSchema(Schema elseSchema)
Sets the "else" schema.default Schema
Schema. ifSchema(Schema ifSchema)
Sets the "if" 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.default Schema
Schema. propertyNames(Schema propertyNameSchema)
Sets the propertyNames property from this Schema instance.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.void
Schema. removePrefixItem(Schema prefixItem)
Removes a schema from the prefixItems list.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. setContains(Schema contains)
Sets the contains property of this Schema instance.void
Schema. setContentSchema(Schema contentSchema)
Sets the contentSchema property from this Schema instance.void
Schema. setElseSchema(Schema elseSchema)
Sets the "else" schema.void
Schema. setIfSchema(Schema ifSchema)
Sets the "if" schema.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
Schema. setPropertyNames(Schema propertyNameSchema)
Sets the propertyNames property from this Schema instance.void
MediaType. setSchema(Schema schema)
Sets the schema field of a MediaType instance to the given schema object.void
Schema. setThenSchema(Schema thenSchema)
Sets the "then" schema.void
Schema. setUnevaluatedItems(Schema unevaluatedItems)
Sets the unevaluatedItems property of this Schema instance.void
Schema. setUnevaluatedProperties(Schema unevaluatedProperties)
Sets the unevaluatedProperties property of this Schema instance.default Schema
Schema. thenSchema(Schema thenSchema)
Sets the "then" schema.default Schema
Schema. unevaluatedItems(Schema unevaluatedItems)
Sets the unevaluatedItems property of this Schema instance.default Schema
Schema. unevaluatedProperties(Schema unevaluatedProperties)
Sets the unevaluatedProperties property of this Schema instance.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. dependentSchemas(Map<String,Schema> dependentSchemas)
Sets the dependentSchemas 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. patternProperties(Map<String,Schema> patternProperties)
Sets the patternProperties property from this Schema instance.default Schema
Schema. prefixItems(List<Schema> prefixItems)
Sets the prefixItems property of this Schema instance.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. setDependentSchemas(Map<String,Schema> dependentSchemas)
Sets the dependentSchemas property of this Schema instance.void
Schema. setOneOf(List<Schema> oneOf)
Sets the schemas used by the oneOf property of this Schema.void
Schema. setPatternProperties(Map<String,Schema> patternProperties)
Sets the patternProperties property from this Schema instance.void
Schema. setPrefixItems(List<Schema> prefixItems)
Sets the prefixItems property of this Schema instance.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.
-