| Package | Description |
|---|---|
| io.swagger.v3.oas.models | |
| io.swagger.v3.oas.models.headers | |
| io.swagger.v3.oas.models.media | |
| io.swagger.v3.oas.models.parameters |
| 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.addSchemas(String key,
Schema schemasItem) |
OpenAPI |
OpenAPI.schema(String name,
Schema schema) |
| Modifier and Type | Method and Description |
|---|---|
Components |
Components.schemas(Map<String,Schema> schemas) |
void |
Components.setSchemas(Map<String,Schema> schemas) |
| 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) |
void |
Header.setSchema(Schema schema) |
| Modifier and Type | Class and Description |
|---|---|
class |
ArraySchema
ArraySchema
|
class |
BinarySchema
BinarySchema
|
class |
BooleanSchema
BooleanSchema
|
class |
ByteArraySchema
ByteArraySchema
|
class |
ComposedSchema
ComposedSchema
|
class |
DateSchema
DateSchema
|
class |
DateTimeSchema
DateTimeSchema
|
class |
EmailSchema
EmailSchema
|
class |
FileSchema
FileSchema
|
class |
IntegerSchema
IntegerSchema
|
class |
JsonSchema
JsonSchema
|
class |
MapSchema
MapSchema
|
class |
NumberSchema
NumberSchema
|
class |
ObjectSchema
ObjectSchema
|
class |
PasswordSchema
PasswordSchema
|
class |
StringSchema
StringSchema
|
class |
UUIDSchema
UUIDSchema
|
| Modifier and Type | Method and Description |
|---|---|
Schema |
Schema._const(Object _const) |
Schema |
Schema._default(T _default) |
Schema |
Schema._else(Schema _else) |
Schema |
Schema._enum(List<T> _enum) |
Schema |
Schema._if(Schema _if) |
Schema |
Schema.$anchor(String $anchor) |
Schema |
Schema.$comment(String $comment) |
Schema |
Schema.$id(String $id) |
Schema |
Schema.$ref(String $ref) |
Schema |
Schema.$schema(String $schema) |
Schema |
Schema.addAllOfItem(Schema allOfItem) |
Schema |
Schema.addAnyOfItem(Schema anyOfItem) |
Schema |
Schema.additionalItems(Schema additionalItems) |
Schema |
Schema.additionalProperties(Object additionalProperties) |
Schema |
Schema.addOneOfItem(Schema oneOfItem) |
Schema |
Schema.addPatternProperty(String key,
Schema patternPropertiesItem) |
Schema |
Schema.addProperties(String key,
Schema property)
Deprecated.
|
Schema |
Schema.addProperty(String key,
Schema property) |
Schema |
Schema.addRequiredItem(String requiredItem) |
Schema |
Schema.allOf(List<Schema> allOf) |
Schema |
Schema.anyOf(List<Schema> anyOf) |
Schema |
Schema.booleanSchemaValue(Boolean booleanSchemaValue) |
Schema |
Schema.contains(Schema contains) |
Schema |
Schema.contentEncoding(String contentEncoding) |
Schema |
Schema.contentMediaType(String contentMediaType) |
Schema |
Schema.contentSchema(Schema contentSchema) |
Schema |
Schema.dependentRequired(Map<String,List<String>> dependentRequired) |
Schema |
Schema.dependentSchemas(Map<String,Schema> dependentSchemas) |
Schema |
Schema.deprecated(Boolean deprecated) |
Schema |
Schema.description(String description) |
Schema |
Schema.discriminator(Discriminator discriminator) |
Schema |
Schema.example(Object example) |
Schema<T> |
Schema.examples(List<T> examples) |
Schema |
Schema.exampleSetFlag(boolean exampleSetFlag) |
Schema |
Schema.exclusiveMaximum(Boolean exclusiveMaximum) |
Schema |
Schema.exclusiveMaximumValue(BigDecimal exclusiveMaximumValue) |
Schema |
Schema.exclusiveMinimum(Boolean exclusiveMinimum) |
Schema |
Schema.exclusiveMinimumValue(BigDecimal exclusiveMinimumValue) |
Schema |
Schema.extensions(Map<String,Object> extensions) |
Schema |
Schema.externalDocs(ExternalDocumentation externalDocs) |
Schema |
Schema.format(String format) |
Schema |
Schema.getAdditionalItems() |
Schema |
Schema.getContains() |
Schema |
Schema.getContentSchema() |
Schema |
Schema.getElse() |
Schema |
Schema.getIf() |
Schema<?> |
Schema.getItems()
returns the items property from a ArraySchema instance.
|
Schema |
Schema.getNot()
returns the not property from a Schema instance.
|
Schema |
Schema.getPropertyNames() |
Schema |
MediaType.getSchema()
returns the schema property from a MediaType instance.
|
Schema |
Schema.getThen() |
Schema |
Schema.getUnevaluatedItems() |
Schema |
Schema.getUnevaluatedProperties() |
Schema |
Schema.items(Schema<?> items) |
Schema |
Schema.jsonSchema(Map<String,Object> jsonSchema) |
Schema |
Schema.jsonSchemaImpl(Object jsonSchemaImpl) |
Schema |
Schema.maxContains(Integer maxContains) |
Schema |
Schema.maximum(BigDecimal maximum) |
Schema |
Schema.maxItems(Integer maxItems) |
Schema |
Schema.maxLength(Integer maxLength) |
Schema |
Schema.maxProperties(Integer maxProperties) |
Schema |
Schema.minContains(Integer minContains) |
Schema |
Schema.minimum(BigDecimal minimum) |
Schema |
Schema.minItems(Integer minItems) |
Schema |
Schema.minLength(Integer minLength) |
Schema |
Schema.minProperties(Integer minProperties) |
Schema |
Schema.multipleOf(BigDecimal multipleOf) |
Schema |
Schema.name(String name) |
Schema |
Schema.not(Schema not) |
Schema |
Schema.nullable(Boolean nullable) |
Schema |
Schema.oneOf(List<Schema> oneOf) |
Schema |
Schema.pattern(String pattern) |
Schema |
Schema.patternProperties(Map<String,Schema> patternProperties) |
Schema |
Schema.prefixItems(List<Schema> prefixItems) |
Schema |
Schema.properties(Map<String,Schema> properties) |
Schema |
Schema.propertyNames(Schema propertyNames) |
Schema |
Schema.raw$ref(String $ref) |
Schema |
Schema.readOnly(Boolean readOnly) |
Schema |
Schema.required(List<String> required) |
Schema |
Schema.specVersion(SpecVersion specVersion) |
Schema |
Schema.then(Schema then) |
Schema |
Schema.title(String title) |
Schema |
Schema.type(String type) |
Schema |
Schema.types(Set<String> types) |
Schema |
Schema.unevaluatedItems(Schema unevaluatedItems) |
Schema |
Schema.unevaluatedProperties(Schema unevaluatedProperties) |
Schema |
Schema.uniqueItems(Boolean uniqueItems) |
Schema |
Schema.writeOnly(Boolean writeOnly) |
Schema |
Schema.xml(XML xml) |
| Modifier and Type | Method and Description |
|---|---|
List<Schema> |
Schema.getAllOf()
returns the allOf property from a ComposedSchema instance.
|
List<Schema> |
Schema.getAnyOf()
returns the anyOf property from a ComposedSchema instance.
|
Map<String,Schema> |
Schema.getDependentSchemas() |
List<Schema> |
Schema.getOneOf()
returns the oneOf property from a ComposedSchema instance.
|
Map<String,Schema> |
Schema.getPatternProperties()
returns the patternProperties property from a Schema instance.
|
List<Schema> |
Schema.getPrefixItems() |
Map<String,Schema> |
Schema.getProperties()
returns the properties property from a Schema instance.
|
| Modifier and Type | Method and Description |
|---|---|
Schema |
Schema._else(Schema _else) |
Schema |
Schema._if(Schema _if) |
Schema |
Schema.addAllOfItem(Schema allOfItem) |
Schema |
Schema.addAnyOfItem(Schema anyOfItem) |
Schema |
Schema.additionalItems(Schema additionalItems) |
Schema |
Schema.addOneOfItem(Schema oneOfItem) |
Schema |
Schema.addPatternProperty(String key,
Schema patternPropertiesItem) |
Schema |
Schema.addProperties(String key,
Schema property)
Deprecated.
|
Schema |
Schema.addProperty(String key,
Schema property) |
Schema |
Schema.contains(Schema contains) |
Schema |
Schema.contentSchema(Schema contentSchema) |
ArraySchema |
ArraySchema.items(Schema items) |
Schema |
Schema.items(Schema<?> items) |
Schema |
Schema.not(Schema not) |
Schema |
Schema.propertyNames(Schema propertyNames) |
MediaType |
MediaType.schema(Schema schema) |
void |
Schema.setAdditionalItems(Schema additionalItems) |
void |
Schema.setContains(Schema contains) |
void |
Schema.setContentSchema(Schema contentSchema) |
void |
Schema.setElse(Schema _else) |
void |
Schema.setIf(Schema _if) |
void |
Schema.setItems(Schema<?> items) |
void |
Schema.setNot(Schema not) |
void |
Schema.setPropertyNames(Schema propertyNames) |
void |
MediaType.setSchema(Schema schema) |
void |
Schema.setThen(Schema then) |
void |
Schema.setUnevaluatedItems(Schema unevaluatedItems) |
void |
Schema.setUnevaluatedProperties(Schema unevaluatedProperties) |
Schema |
Schema.then(Schema then) |
Schema |
Schema.unevaluatedItems(Schema unevaluatedItems) |
Schema |
Schema.unevaluatedProperties(Schema unevaluatedProperties) |
| Modifier and Type | Method and Description |
|---|---|
Schema |
Schema.allOf(List<Schema> allOf) |
Schema |
Schema.anyOf(List<Schema> anyOf) |
Schema |
Schema.dependentSchemas(Map<String,Schema> dependentSchemas) |
Schema |
Schema.oneOf(List<Schema> oneOf) |
Schema |
Schema.patternProperties(Map<String,Schema> patternProperties) |
Schema |
Schema.prefixItems(List<Schema> prefixItems) |
Schema |
Schema.properties(Map<String,Schema> properties) |
void |
Schema.setAllOf(List<Schema> allOf) |
void |
Schema.setAnyOf(List<Schema> anyOf) |
void |
Schema.setDependentSchemas(Map<String,Schema> dependentSchemas) |
void |
Schema.setOneOf(List<Schema> oneOf) |
void |
Schema.setPatternProperties(Map<String,Schema> patternProperties) |
void |
Schema.setPrefixItems(List<Schema> prefixItems) |
void |
Schema.setProperties(Map<String,Schema> properties) |
| 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) |
void |
Parameter.setSchema(Schema schema) |
Copyright © 2022. All rights reserved.