Package | Description |
---|---|
org.eclipse.microprofile.openapi |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
org.eclipse.microprofile.openapi.models |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
org.eclipse.microprofile.openapi.models.headers |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
org.eclipse.microprofile.openapi.models.media |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
org.eclipse.microprofile.openapi.models.parameters |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
Modifier and Type | Method and Description |
---|---|
default Schema |
OASFilter.filterSchema(Schema schema)
Allows filtering of a particular Schema.
|
Modifier and Type | Method and Description |
---|---|
default Schema |
OASFilter.filterSchema(Schema schema)
Allows filtering of a particular Schema.
|
Modifier and Type | Method and Description |
---|---|
Map<String,Schema> |
Components.getSchemas()
Returns the schemas property from a Components instance.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
Schema |
Header.getSchema()
Returns the schema property from a Header instance.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and 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.
|
Schema |
Schema.additionalProperties(Boolean additionalProperties)
Sets the value of "additionalProperties" to either True or False.
|
Schema |
Schema.additionalProperties(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.
|
Schema |
Schema.allOf(List<Schema> allOf)
Sets the schemas used by the allOf property of this Schema.
|
Schema |
Schema.anyOf(List<Schema> anyOf)
Sets the schemas used by the anyOf property of this Schema.
|
Schema |
Schema.defaultValue(Object defaultValue)
Set the default value property of this Schema instance to the value given.
|
Schema |
Schema.deprecated(Boolean deprecated)
Sets the deprecated property of this Schema.
|
Schema |
Schema.description(String description)
Sets the description property of this Schema to the given string.
|
Schema |
Schema.discriminator(Discriminator discriminator)
Sets the discriminator property of this Schema instance to the given object.
|
Schema |
Schema.enumeration(List<Object> enumeration) |
Schema |
Schema.example(Object example)
Sets the example property of this Schema instance.
|
Schema |
Schema.exclusiveMaximum(Boolean exclusiveMaximum)
Sets the exclusiveMaximum property of this Schema instance to the value given.
|
Schema |
Schema.exclusiveMinimum(Boolean exclusiveMinimum)
Sets the exclusiveMinimum property of this Schema instance to the value given.
|
Schema |
Schema.externalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of this Schema to the indicated value.
|
Schema |
Schema.format(String format)
Sets the format property of this Schema instance to the given string.
|
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.
|
Schema |
Schema.items(Schema items)
Set the Schema used for all the elements of an array typed Schema.
|
Schema |
Schema.maximum(BigDecimal maximum)
Sets the maximum property of this Schema instance to the value given.
|
Schema |
Schema.maxItems(Integer maxItems)
Sets the maxItems property of this Schema instance to the value given.
|
Schema |
Schema.maxLength(Integer maxLength)
Sets the maxLength property of this Schema instance to the value given.
|
Schema |
Schema.maxProperties(Integer maxProperties)
Sets the maxProperties property of this Schema instance to the value given.
|
Schema |
Schema.minimum(BigDecimal minimum)
Sets the minimum property of this Schema instance to the value given.
|
Schema |
Schema.minItems(Integer minItems)
Sets the minItems property of this Schema instance to the value given.
|
Schema |
Schema.minLength(Integer minLength)
Sets the minLength property of this Schema instance to the value given.
|
Schema |
Schema.minProperties(Integer minProperties)
Sets the minProperties property of this Schema instance to the value given.
|
Schema |
Schema.multipleOf(BigDecimal multipleOf)
Sets the multipleOf property of this Schema instance to the value given.
|
Schema |
Schema.not(Schema not)
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
|
Schema |
Schema.nullable(Boolean nullable)
Sets the nullable property of this Schema instance.
|
Schema |
Schema.oneOf(List<Schema> oneOf)
Sets the schemas used by the oneOf property of this Schema.
|
Schema |
Schema.pattern(String pattern)
Sets the pattern property of this Schema instance to the string given.
|
Schema |
Schema.properties(Map<String,Schema> properties)
Sets the properties of this Schema instance to the map provided.
|
Schema |
Schema.readOnly(Boolean readOnly)
Sets the readOnly property of this Schema.
|
Schema |
Schema.required(List<String> required)
Sets the list of fields required in objects defined by this Schema.
|
Schema |
Schema.title(String title)
Sets the title property of this Schema instance to the given string.
|
Schema |
Schema.type(Schema.SchemaType type)
Sets the type used by this Schema to the string given.
|
Schema |
Schema.uniqueItems(Boolean uniqueItems)
Sets the uniqueItems property of this Schema instance to the value given.
|
Schema |
Schema.writeOnly(Boolean writeOnly)
Sets the writeOnly property of this Schema.
|
Schema |
Schema.xml(XML xml)
Sets the xml property of this Schema instance.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and 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.additionalProperties(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.items(Schema items)
Set the Schema used for all the elements of an array typed Schema.
|
Schema |
Schema.not(Schema not)
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
|
MediaType |
MediaType.schema(Schema schema)
Sets the schema field of a MediaType instance to the given schema object.
|
void |
Schema.setAdditionalProperties(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.
|
Modifier and Type | Method and Description |
---|---|
Schema |
Schema.allOf(List<Schema> allOf)
Sets the schemas used by the allOf property of this Schema.
|
Schema |
Schema.anyOf(List<Schema> anyOf)
Sets the schemas used by the anyOf property of this Schema.
|
Schema |
Schema.oneOf(List<Schema> oneOf)
Sets the schemas used by the oneOf property of this Schema.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Schema |
Parameter.getSchema()
Returns the schema property from a Parameter instance.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Copyright © 2017–2018 Eclipse MicroProfile. All rights reserved.