$ A B C D E F H I K L M N O P Q R S T U V W _
All Classes All Packages
All Classes All Packages
All Classes All Packages
$
- $anchor() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the $anchor related to schema
- $comment() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides $comment related to this schema
- $dynamicAnchor() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the $dynamicAnchor related to schema
- $id() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the $id related to this schema.
- $schema() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides Json Schema dialect where the schema is valid.
- $vocabulary() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the $vocabulary related to schema
A
- accessMode() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows to specify the access mode (AccessMode.READ_ONLY, READ_WRITE) AccessMode.READ_ONLY: value will not be written to during a request but may be returned during a response.
- additionalItems() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a list of additional items
- additionalProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows to specify the additionalProperties value AdditionalPropertiesValue.TRUE: set to TRUE AdditionalPropertiesValue.FALSE: set to FALSE AdditionalPropertiesValue.USE_ADDITIONAL_PROPERTIES_ANNOTATION: resolve from @Content.additionalPropertiesSchema or @Schema.additionalPropertiesSchema
- additionalPropertiesArraySchema() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The additionalProperties array schema defined for schema provided in @Schema If the additionalProperties schema is not an array, use additionalPropertiesSchema
- additionalPropertiesSchema() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The additionalProperties schema defined for schema provided in @Schema If the additionalProperties schema is an array, use additionalPropertiesArraySchema
- additionalPropertiesSchema() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
- allOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the allOf sub schemas related to this schema..
- allOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- allowableValues() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a list of allowable values.
- allowableValues() - Method in annotation type io.swagger.v3.oas.annotations.servers.ServerVariable
-
An array of allowable values for this variable.
- allowEmptyValue() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
When true, allows sending an empty value.
- allowReserved() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 to be included without percent-encoding.
- allowReserved() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Determines whether the parameter value should allow reserved characters, as defined by RFC3986.
- anyOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the anyOf sub schemas related to this schema.
- anyOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- APIKEY - io.swagger.v3.oas.annotations.enums.SecuritySchemeType
- ApiResponse - Annotation Type in io.swagger.v3.oas.annotations.responses
-
The annotation may be used at method level or as field of
Operation
to define one or more responses of the Operation. - ApiResponses - Annotation Type in io.swagger.v3.oas.annotations.responses
-
Container for repeatable
ApiResponse
annotation - array() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
The schema of the array that defines this header.
- array() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The schema of the array that defines the type used for the content.
- array() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentSchema
-
The value (ArraySchema) of the dependent schema map item.
- array() - Method in annotation type io.swagger.v3.oas.annotations.media.PatternProperty
-
The schema of the array to validate against for properties matching the regex.
- array() - Method in annotation type io.swagger.v3.oas.annotations.media.SchemaProperty
-
The schema of the array.
- array() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
The schema of the array that defines this parameter.
- arraySchema() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Allows to define the properties to be resolved into properties of the schema of type `array` (not the ones of the `items` of such schema which are defined in
schema
. - ArraySchema - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to define a schema of type "array" for a set of elements of the OpenAPI spec, and/or to define additional properties for the schema.
- authorizationCode() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlows
-
Configuration for the OAuth Authorization Code flow.
- authorizationUrl() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlow
-
The authorization URL to be used for this flow.
- AUTO - io.swagger.v3.oas.annotations.media.Schema.AccessMode
- AUTO - io.swagger.v3.oas.annotations.media.Schema.RequiredMode
B
- bearerFormat() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
A hint to the client to identify how the bearer token is formatted.
C
- Callback - Annotation Type in io.swagger.v3.oas.annotations.callbacks
-
The annotation may be used at method level to add one ore more callbacks to the operation definition.
- Callbacks - Annotation Type in io.swagger.v3.oas.annotations.callbacks
-
Container for repeatable
Callback
annotation - callbackUrlExpression() - Method in annotation type io.swagger.v3.oas.annotations.callbacks.Callback
-
An absolute URL which defines the destination which will be called with the supplied operation definition.
- clientCredentials() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlows
-
Configuration for the OAuth Client Credentials flow.
- contact() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
The contact information for the exposed API.
- Contact - Annotation Type in io.swagger.v3.oas.annotations.info
-
The annotation may be used in
Info.contact()
to define a contact for the OpenAPI spec. - contains() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Specifies contains constrictions expressions.
- contains() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Specifies contains constrictions expressions.
- content() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
The representation of this parameter, for different media types.
- content() - Method in annotation type io.swagger.v3.oas.annotations.parameters.RequestBody
-
The content of the request body.
- content() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
An array containing descriptions of potential response payloads, for different media types.
- Content - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to define the content/media type of a parameter, request or response, by defining it as field
Parameter.content()
,RequestBody.content()
orApiResponse.content()
. - contentEncoding() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the content encoding related to this schema
- contentMediaType() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the content media type related to this schema
- contentSchema() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the content schema related to this schema
- contentSchema() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the content schema related to this schema
- contentType() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
The Content-Type for encoding a specific property.
- COOKIE - io.swagger.v3.oas.annotations.enums.ParameterIn
- COOKIE - io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
D
- DEEPOBJECT - io.swagger.v3.oas.annotations.enums.ParameterStyle
- DEFAULT - io.swagger.v3.oas.annotations.enums.Explode
- DEFAULT - io.swagger.v3.oas.annotations.enums.ParameterIn
- DEFAULT - io.swagger.v3.oas.annotations.enums.ParameterStyle
- DEFAULT - io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
- DEFAULT - io.swagger.v3.oas.annotations.enums.SecuritySchemeType
- defaultValue() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a default value.
- defaultValue() - Method in annotation type io.swagger.v3.oas.annotations.servers.ServerVariable
-
Required.
- DependentRequired - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to define dependent schemas for an Object Schema
- dependentRequiredMap() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows to specify the dependentRequired value
- DependentRequiredMap - Annotation Type in io.swagger.v3.oas.annotations.media
-
Container for repeatable
DependentRequired
annotation - DependentSchema - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to define dependent schemas for an Object Schema
- dependentSchemas() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Subschemas to be applied for a given condition.
- dependentSchemas() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows to specify the dependentSchemas value providing a Class to be resolved into a Schema
- DependentSchemas - Annotation Type in io.swagger.v3.oas.annotations.media
-
Container for repeatable
DependentSchema
annotation - deprecated() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
Specifies that a header is deprecated and should be transitioned out of usage.
- deprecated() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Specifies that a schema is deprecated and should be transitioned out of usage.
- deprecated() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Allows an operation to be marked as deprecated.
- deprecated() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Specifies that a parameter is deprecated and should be transitioned out of usage.
- description() - Method in annotation type io.swagger.v3.oas.annotations.ExternalDocumentation
-
A short description of the target documentation.
- description() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
Additional description data to provide on the purpose of the header
- description() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
A short description of the application.
- description() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
A description of the link.
- description() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
A description of the purpose or context of the example
- description() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
A description of the schema.
- description() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
A verbose description of the operation.
- description() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Additional description data to provide on the purpose of the parameter
- description() - Method in annotation type io.swagger.v3.oas.annotations.parameters.RequestBody
-
A brief description of the request body.
- description() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
A short description of the response.
- description() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthScope
-
Short description of the scope.
- description() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
A short description for security scheme.
- description() - Method in annotation type io.swagger.v3.oas.annotations.servers.Server
-
An optional string describing the host designated by the URL.
- description() - Method in annotation type io.swagger.v3.oas.annotations.servers.ServerVariable
-
An optional description for the server variable.
- description() - Method in annotation type io.swagger.v3.oas.annotations.tags.Tag
-
A short description for this tag.
- discriminatorMapping() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides discriminator mapping values.
- DiscriminatorMapping - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used in
Schema.discriminatorMapping()
to define an optional mapping definition in scenarios involving composition / inheritance where the value of the discriminator field does not match the schema name or implicit mapping is not possible. - discriminatorProperty() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a discriminator property value.
E
- email() - Method in annotation type io.swagger.v3.oas.annotations.info.Contact
-
The email address of the contact person/organization.
- encoding() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
An array of encodings The key, being the property name, MUST exist in the schema as a property.
- Encoding - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to add encoding details to the definition of a parameter, request or response content, by defining it as field
Content.encoding()
- enumAsRef() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows enums to be resolved as a reference to a scheme added to components section.
- example() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
Provides an example of the schema.
- example() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an example of the schema.
- example() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Provides an example of the schema.
- exampleClasses() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a list of examples related to this schema
- ExampleObject - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to add one or more examples to the definition of a parameter, request or response content, by defining it as field
Parameter.examples()
orContent.examples()
- examples() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
An array of examples of the schema used to show the use of the associated schema.
- examples() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
An array of examples used to show the use of the associated schema.
- examples() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an array of examples of the schema.
- examples() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
An array of examples of the schema used to show the use of the associated schema.
- exclusiveMaximum() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
if true, makes the maximum value exclusive, or a less-than criteria.
- exclusiveMaximumValue() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
- exclusiveMinimum() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
If true, makes the minimum value exclusive, or a greater-than criteria.
- exclusiveMinimumValue() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an exclusive minimum for a expressing exclusive range.
- explode() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.
- explode() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
- explode() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.
- Explode - Enum in io.swagger.v3.oas.annotations.enums
- expression() - Method in annotation type io.swagger.v3.oas.annotations.links.LinkParameter
-
A constant or an expression to be evaluated and passed to the linked operation.
- Extension - Annotation Type in io.swagger.v3.oas.annotations.extensions
-
An optionally named list of extension properties.
- ExtensionProperty - Annotation Type in io.swagger.v3.oas.annotations.extensions
-
A name/value property within a OpenApi extension
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.callbacks.Callback
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.ExternalDocumentation
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.info.Contact
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.info.License
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.media.DiscriminatorMapping
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.OpenAPIDefinition
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.parameters.RequestBody
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponses
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlow
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlows
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.servers.Server
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.servers.ServerVariable
-
The list of optional extensions
- extensions() - Method in annotation type io.swagger.v3.oas.annotations.tags.Tag
-
The list of optional extensions
- Extensions - Annotation Type in io.swagger.v3.oas.annotations.extensions
-
Container for repeatable
Extension
annotation - externalDocs() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Additional external documentation for this schema.
- externalDocs() - Method in annotation type io.swagger.v3.oas.annotations.OpenAPIDefinition
-
Any additional external documentation for the API
- externalDocs() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Additional external documentation for this operation.
- externalDocs() - Method in annotation type io.swagger.v3.oas.annotations.tags.Tag
-
Additional external documentation for this tag.
- ExternalDocumentation - Annotation Type in io.swagger.v3.oas.annotations
-
The annotation may be used at method level or as field of
Operation
to add a reference to an external resource for extended documentation of an Operation (OpenAPI specification). - externalValue() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
A URL to point to an external document to be used as an example.
F
- FALSE - io.swagger.v3.oas.annotations.enums.Explode
- FALSE - io.swagger.v3.oas.annotations.media.Schema.AdditionalPropertiesValue
- flows() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
Required.
- FORM - io.swagger.v3.oas.annotations.enums.ParameterStyle
- format() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an optional override for the format.
H
- Header - Annotation Type in io.swagger.v3.oas.annotations.headers
-
The annotation may be used to add one or more headers to the definition of a response or as attribute of content encoding by defining it as field
ApiResponse.headers()
orContent.encoding()
. - HEADER - io.swagger.v3.oas.annotations.enums.ParameterIn
- HEADER - io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
- headers() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
An array of header objects
- headers() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
An array of response headers.
- hidden() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
Allows this header to be marked as hidden
- hidden() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows schema to be marked as hidden.
- hidden() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Allows this operation to be marked as hidden
- hidden() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Allows this parameter to be marked as hidden
- Hidden - Annotation Type in io.swagger.v3.oas.annotations
-
Marks a given resource, class or bean type as hidden, skipping while reading / resolving
- HTTP - io.swagger.v3.oas.annotations.enums.SecuritySchemeType
I
- identifier() - Method in annotation type io.swagger.v3.oas.annotations.info.License
-
An identifier for a License instance.
- ignoreJsonView() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Ignores JsonView annotations while resolving operations and types.
- implementation() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a java class as implementation for this schema.
- implicit() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlows
-
Configuration for the OAuth Implicit flow.
- in() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
The location of the parameter.
- in() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
The location of the API key.
- info() - Method in annotation type io.swagger.v3.oas.annotations.OpenAPIDefinition
-
Provides metadata about the API.
- Info - Annotation Type in io.swagger.v3.oas.annotations.info
-
The annotation may be used in
OpenAPIDefinition.info()
to populate the Info section of the OpenAPI document. - io.swagger.v3.oas.annotations - package io.swagger.v3.oas.annotations
- io.swagger.v3.oas.annotations.callbacks - package io.swagger.v3.oas.annotations.callbacks
- io.swagger.v3.oas.annotations.enums - package io.swagger.v3.oas.annotations.enums
- io.swagger.v3.oas.annotations.extensions - package io.swagger.v3.oas.annotations.extensions
- io.swagger.v3.oas.annotations.headers - package io.swagger.v3.oas.annotations.headers
- io.swagger.v3.oas.annotations.info - package io.swagger.v3.oas.annotations.info
- io.swagger.v3.oas.annotations.links - package io.swagger.v3.oas.annotations.links
- io.swagger.v3.oas.annotations.media - package io.swagger.v3.oas.annotations.media
- io.swagger.v3.oas.annotations.parameters - package io.swagger.v3.oas.annotations.parameters
- io.swagger.v3.oas.annotations.responses - package io.swagger.v3.oas.annotations.responses
- io.swagger.v3.oas.annotations.security - package io.swagger.v3.oas.annotations.security
- io.swagger.v3.oas.annotations.servers - package io.swagger.v3.oas.annotations.servers
- io.swagger.v3.oas.annotations.tags - package io.swagger.v3.oas.annotations.tags
- items() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Deprecated.since 2.2.21, use
ArraySchema.schema()
instead. Marked for removal in future versions.
K
- key() - Method in annotation type io.swagger.v3.oas.annotations.StringToClassMapItem
L
- LABEL - io.swagger.v3.oas.annotations.enums.ParameterStyle
- license() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
The license information for the exposed API.
- License - Annotation Type in io.swagger.v3.oas.annotations.info
-
The annotation may be used in
Info.license()
to define a license for the OpenAPI spec. - Link - Annotation Type in io.swagger.v3.oas.annotations.links
-
The annotation may be applied in
ApiResponse.links()
to add OpenAPI links to a response. - LinkParameter - Annotation Type in io.swagger.v3.oas.annotations.links
-
Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
- links() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
An array of operation links that can be followed from the response.
M
- MATRIX - io.swagger.v3.oas.annotations.enums.ParameterStyle
- maxContains() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Provides max contains related to this schema
- maxContains() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides max contains related to this schema
- maximum() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Sets the maximum numeric value for a property.
- maxItems() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
sets the maximum number of items in an array.
- maxLength() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Sets the maximum length of a string value.
- maxProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Constrains the number of arbitrary properties when additionalProperties is defined.
- mediaType() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The media type that this object applies to.
- method() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
The HTTP method for this operation.
- minContains() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Provides min contains related to this schema
- minContains() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides min contains related to this schema
- minimum() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Sets the minimum numeric value for a property.
- minItems() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
sets the minimum number of items in an array.
- minLength() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Sets the minimum length of a string value.
- minProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Constrains the number of arbitrary properties when additionalProperties is defined.
- multipleOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Constrains a value such that when divided by the multipleOf, the remainder must be an integer.
- MUTUALTLS - io.swagger.v3.oas.annotations.enums.SecuritySchemeType
N
- name() - Method in annotation type io.swagger.v3.oas.annotations.callbacks.Callback
-
The friendly name used to refer to this callback
- name() - Method in annotation type io.swagger.v3.oas.annotations.extensions.Extension
-
An option name for these extensions.
- name() - Method in annotation type io.swagger.v3.oas.annotations.extensions.ExtensionProperty
-
The name of the property.
- name() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
Required: The name of the header.
- name() - Method in annotation type io.swagger.v3.oas.annotations.info.Contact
-
The identifying name of the contact person/organization.
- name() - Method in annotation type io.swagger.v3.oas.annotations.info.License
-
The license name used for the API.
- name() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
The name of this link.
- name() - Method in annotation type io.swagger.v3.oas.annotations.links.LinkParameter
-
The name of this link parameter.
- name() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentRequired
-
The name.
- name() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentSchema
-
The name.
- name() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
The name of this encoding object instance.
- name() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
A unique name to identify this particular example
- name() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
The name of the schema or property.
- name() - Method in annotation type io.swagger.v3.oas.annotations.media.SchemaProperty
-
The name.
- name() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
The name of the parameter.
- name() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthScope
-
Name of the scope.
- name() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityRequirement
-
This name must correspond to a declared SecurityRequirement.
- name() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
The name identifying this security scheme
- name() - Method in annotation type io.swagger.v3.oas.annotations.servers.ServerVariable
-
Required.
- name() - Method in annotation type io.swagger.v3.oas.annotations.tags.Tag
-
The name of this tag.
- name() - Method in annotation type io.swagger.v3.oas.annotations.Webhook
-
Provides the name related to this webhook.
- not() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Set schemas to validate according a given condition.
- not() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a java class to be used to disallow matching properties.
- NOT_REQUIRED - io.swagger.v3.oas.annotations.media.Schema.RequiredMode
- nullable() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
If true, designates a value as possibly null.
O
- OAUTH2 - io.swagger.v3.oas.annotations.enums.SecuritySchemeType
- OAuthFlow - Annotation Type in io.swagger.v3.oas.annotations.security
-
Configuration details for a supported OAuth Flow.
- OAuthFlows - Annotation Type in io.swagger.v3.oas.annotations.security
-
Allows configuration of the supported OAuth Flows.
- OAuthScope - Annotation Type in io.swagger.v3.oas.annotations.security
-
Represents an OAuth scope.
- oneOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the oneOf sub schemas related to this schema.
- oneOf() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- OpenAPI31 - Annotation Type in io.swagger.v3.oas.annotations
- OpenAPIDefinition - Annotation Type in io.swagger.v3.oas.annotations
-
The annotation that may be used to populate OpenAPI Object fields info, tags, servers, security and externalDocs If more than one class is annotated with
OpenAPIDefinition
, with the same fields defined, behaviour is inconsistent. - OPENIDCONNECT - io.swagger.v3.oas.annotations.enums.SecuritySchemeType
- openIdConnectUrl() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
Required.
- operation() - Method in annotation type io.swagger.v3.oas.annotations.callbacks.Callback
-
The array of operations that will be called out-of band
- operation() - Method in annotation type io.swagger.v3.oas.annotations.Webhook
-
Provides the operation related to this webhook.
- Operation - Annotation Type in io.swagger.v3.oas.annotations
-
The annotation may be used to define a resource method as an OpenAPI Operation, and/or to define additional properties for the Operation.
- operationId() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
The name of an existing, resolvable OAS operation, as defined with a unique operationId.
- operationId() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
The operationId is used by third-party tools to uniquely identify this operation.
- operationRef() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
A relative or absolute reference to an OAS operation.
P
- Parameter - Annotation Type in io.swagger.v3.oas.annotations
-
The annotation may be used on a method parameter to define it as a parameter for the operation, and/or to define additional properties for the Parameter.
- ParameterIn - Enum in io.swagger.v3.oas.annotations.enums
- parameters() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
- parameters() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
An optional array of parameters which will be added to any automatically detected parameters in the method itself.
- Parameters - Annotation Type in io.swagger.v3.oas.annotations
-
Container for repeatable
Parameter
annotation - ParameterStyle - Enum in io.swagger.v3.oas.annotations.enums
- paramName() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
The name of the header or query parameter to be used.
- parseValue() - Method in annotation type io.swagger.v3.oas.annotations.extensions.ExtensionProperty
-
If set to true, field `value` will be parsed and serialized as JSON/YAML
- password() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlows
-
Configuration for the OAuth Resource Owner Password flow.
- PATH - io.swagger.v3.oas.annotations.enums.ParameterIn
- pattern() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
A pattern that the value must satisfy.
- patternProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides pattern properties to this schema
- PatternProperties - Annotation Type in io.swagger.v3.oas.annotations.media
-
Container for repeatable
PatternProperty
annotation - PatternProperty - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used in OpenAPI 3.1 schemas / JSON Schema.
- PIPEDELIMITED - io.swagger.v3.oas.annotations.enums.ParameterStyle
- prefixItems() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Provides prefix items to this schema
- prefixItems() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
List of optional items positionally defines before normal items.
- properties() - Method in annotation type io.swagger.v3.oas.annotations.extensions.Extension
-
The extension properties.
- properties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides properties related to this schema
- propertyNames() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides property names related to this schema
- propertyNames() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides property names related to this schema
Q
- QUERY - io.swagger.v3.oas.annotations.enums.ParameterIn
- QUERY - io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
R
- READ_ONLY - io.swagger.v3.oas.annotations.media.Schema.AccessMode
- READ_WRITE - io.swagger.v3.oas.annotations.media.Schema.AccessMode
- readOnly() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Deprecated.As of 2.0.0, replaced by
Schema.accessMode()
- ref() - Method in annotation type io.swagger.v3.oas.annotations.callbacks.Callback
-
A reference to a Callback defined in components Callbacks.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
A reference to a header defined in components headers.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
A reference to a link defined in components links.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
A reference to a example defined in components examples.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
References a schema definition in an external OpenAPI document.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
A reference to a parameter defined in components parameter.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.parameters.RequestBody
-
A reference to a RequestBody defined in components RequestBodies.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
A reference to a response defined in components responses.
- ref() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
A reference to a SecurityScheme defined in components securitySchemes.
- refreshUrl() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlow
-
The URL to be used for obtaining refresh tokens.
- regex() - Method in annotation type io.swagger.v3.oas.annotations.media.PatternProperty
-
The regex.
- requestBody() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
A literal value or {expression} to use as a request body when calling the target operation.
- requestBody() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Request body associated to the operation.
- RequestBody - Annotation Type in io.swagger.v3.oas.annotations.parameters
-
The annotation may be used on a method parameter to define it as the Request Body of the operation, and/or to define additional properties for such request body.
- required() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
Determines whether this header is mandatory.
- required() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Deprecated.since 2.2.5, replaced by
Schema.requiredMode()
- required() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Determines whether this parameter is mandatory.
- required() - Method in annotation type io.swagger.v3.oas.annotations.parameters.RequestBody
-
Determines if the request body is required in the request.
- REQUIRED - io.swagger.v3.oas.annotations.media.Schema.RequiredMode
- requiredMode() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows to specify the required mode (RequiredMode.AUTO, REQUIRED, NOT_REQUIRED) RequiredMode.AUTO: will let the library decide based on its heuristics.
- requiredProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Allows multiple properties in an object to be marked as required.
- responseCode() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
The HTTP response code, or 'default', for the supplied response.
- responses() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
The list of possible responses as they are returned from executing this operation.
S
- schema() - Method in annotation type io.swagger.v3.oas.annotations.headers.Header
-
The schema defining the type used for the header.
- schema() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
The schema of the items in the array
- schema() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The schema defining the type used for the content.
- schema() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentSchema
-
The value (Schema) of the dependent schema map item.
- schema() - Method in annotation type io.swagger.v3.oas.annotations.media.DiscriminatorMapping
-
The schema that is being mapped to a property value
- schema() - Method in annotation type io.swagger.v3.oas.annotations.media.PatternProperty
-
The schema to validate against for properties matching the regex.
- schema() - Method in annotation type io.swagger.v3.oas.annotations.media.SchemaProperty
-
The schema of the property.
- schema() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
The schema defining the type used for the parameter.
- Schema - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to define a Schema for a set of elements of the OpenAPI spec, and/or to define additional properties for the schema.
- Schema.AccessMode - Enum in io.swagger.v3.oas.annotations.media
- Schema.AdditionalPropertiesValue - Enum in io.swagger.v3.oas.annotations.media
- Schema.RequiredMode - Enum in io.swagger.v3.oas.annotations.media
- schemaProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
The schema properties defined for schema provided in @Schema
- SchemaProperties - Annotation Type in io.swagger.v3.oas.annotations.media
-
Container for repeatable
SchemaProperty
annotation - SchemaProperty - Annotation Type in io.swagger.v3.oas.annotations.media
-
The annotation may be used to define properties for an Object Schema
- scheme() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC 7235.
- scopes() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlow
-
The available scopes for the OAuth2 security scheme.
- scopes() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityRequirement
-
If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution.
- security() - Method in annotation type io.swagger.v3.oas.annotations.OpenAPIDefinition
-
A declaration of which security mechanisms can be used across the API.
- security() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
A declaration of which security mechanisms can be used for this operation.
- SecurityRequirement - Annotation Type in io.swagger.v3.oas.annotations.security
-
The annotation may be applied at class or method level, or in
Operation.security()
()} to define security requirements for the single operation (when applied at method level) or for all operations of a class (when applied at class level). - SecurityRequirements - Annotation Type in io.swagger.v3.oas.annotations.security
-
Container for repeatable
SecurityRequirement
annotation - SecurityScheme - Annotation Type in io.swagger.v3.oas.annotations.security
-
The annotation may be used at class level (also on multiple classes) to add securitySchemes to spec components section.
- SecuritySchemeIn - Enum in io.swagger.v3.oas.annotations.enums
- SecuritySchemes - Annotation Type in io.swagger.v3.oas.annotations.security
-
Container for repeatable
SecurityScheme
annotation - SecuritySchemeType - Enum in io.swagger.v3.oas.annotations.enums
- server() - Method in annotation type io.swagger.v3.oas.annotations.links.Link
-
An alternative server to service this operation.
- Server - Annotation Type in io.swagger.v3.oas.annotations.servers
-
The annotation may be applied at class or method level, or in
Operation.servers()
to define servers for the single operation (when applied at method level) or for all operations of a class (when applied at class level). - servers() - Method in annotation type io.swagger.v3.oas.annotations.OpenAPIDefinition
-
An array of Server Objects, which provide connectivity information to a target server.
- servers() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
An alternative server array to service this operation.
- Servers - Annotation Type in io.swagger.v3.oas.annotations.servers
-
Container for repeatable
Server
annotation - ServerVariable - Annotation Type in io.swagger.v3.oas.annotations.servers
-
An object representing a Server Variable for server URL template substitution.
- SIMPLE - io.swagger.v3.oas.annotations.enums.ParameterStyle
- SPACEDELIMITED - io.swagger.v3.oas.annotations.enums.ParameterStyle
- StringToClassMapItem - Annotation Type in io.swagger.v3.oas.annotations
- style() - Method in annotation type io.swagger.v3.oas.annotations.media.Encoding
-
Describes how a specific property value will be serialized depending on its type
- style() - Method in annotation type io.swagger.v3.oas.annotations.Parameter
-
Describes how the parameter value will be serialized depending on the type of the parameter value.
- subTypes() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
An array of the sub types inheriting from this model.
- summary() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
A short API summary.
- summary() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
A brief summary of the purpose or context of the example
- summary() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Provides a brief description of this operation.
T
- Tag - Annotation Type in io.swagger.v3.oas.annotations.tags
-
The annotation may be applied at class or method level, or in
Operation.tags()
to define tags for the single operation (when applied at method level) or for all operations of a class (when applied at class level). - tags() - Method in annotation type io.swagger.v3.oas.annotations.OpenAPIDefinition
-
A list of tags used by the specification with additional metadata.
- tags() - Method in annotation type io.swagger.v3.oas.annotations.Operation
-
Tags can be used for logical grouping of operations by resources or any other qualifier.
- Tags - Annotation Type in io.swagger.v3.oas.annotations.tags
-
Container for repeatable
Tag
annotation - termsOfService() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
A URL to the Terms of Service for the API.
- then() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the then sub schema related to this schema
- title() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
The title of the application.
- title() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
A title to explain the purpose of the schema.
- tokenUrl() - Method in annotation type io.swagger.v3.oas.annotations.security.OAuthFlow
-
The token URL to be used for this flow.
- toString() - Method in enum io.swagger.v3.oas.annotations.enums.ParameterIn
- toString() - Method in enum io.swagger.v3.oas.annotations.enums.ParameterStyle
- toString() - Method in enum io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
- toString() - Method in enum io.swagger.v3.oas.annotations.enums.SecuritySchemeType
- TRUE - io.swagger.v3.oas.annotations.enums.Explode
- TRUE - io.swagger.v3.oas.annotations.media.Schema.AdditionalPropertiesValue
- type() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides an override for the basic type of the schema.
- type() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityScheme
-
The type of the security scheme.
- types() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
List of schema types
U
- unevaluatedItems() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
Provides unevaluted items to this schema
- unevaluatedItems() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides a list of unevaluated items
- unevaluatedProperties() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides unevaluated properties to this schema
- uniqueItems() - Method in annotation type io.swagger.v3.oas.annotations.media.ArraySchema
-
determines whether an array of items will be unique
- url() - Method in annotation type io.swagger.v3.oas.annotations.ExternalDocumentation
-
The URL for the target documentation.
- url() - Method in annotation type io.swagger.v3.oas.annotations.info.Contact
-
The URL pointing to the contact information.
- url() - Method in annotation type io.swagger.v3.oas.annotations.info.License
-
A URL to the license used for the API.
- url() - Method in annotation type io.swagger.v3.oas.annotations.servers.Server
-
Required.
- USE_ADDITIONAL_PROPERTIES_ANNOTATION - io.swagger.v3.oas.annotations.media.Schema.AdditionalPropertiesValue
- useParameterTypeSchema() - Method in annotation type io.swagger.v3.oas.annotations.parameters.RequestBody
-
Set to true to resolve the request body schema from parameter type
- useReturnTypeSchema() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponse
-
Set to true to resolve the response schema from method return type
V
- value() - Method in annotation type io.swagger.v3.oas.annotations.callbacks.Callbacks
-
An array of Callback annotations which are a map of possible out-of band callbacks related to the parent operation
- value() - Method in annotation type io.swagger.v3.oas.annotations.extensions.ExtensionProperty
-
The value of the property.
- value() - Method in annotation type io.swagger.v3.oas.annotations.extensions.Extensions
-
An array of Extension annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentRequired
-
The values of the dependent schema.
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentRequiredMap
-
An array of DependentRequired annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.DependentSchemas
-
An array of DependentSchema annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.DiscriminatorMapping
-
The property value that will be mapped to a Schema
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.ExampleObject
-
A string representation of the example.
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.PatternProperties
-
An array of PatternProperty annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.media.SchemaProperties
-
An array of SchemaProperty annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.Parameters
-
An array of Parameters Objects for the operation
- value() - Method in annotation type io.swagger.v3.oas.annotations.responses.ApiResponses
-
An array of ApiResponse annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.security.SecurityRequirements
-
An array of SecurityRequirement annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.security.SecuritySchemes
-
An array of SecurityScheme annotations
- value() - Method in annotation type io.swagger.v3.oas.annotations.servers.Servers
-
An array of Server Objects which is used to provide connectivity information to a target server.
- value() - Method in annotation type io.swagger.v3.oas.annotations.StringToClassMapItem
- value() - Method in annotation type io.swagger.v3.oas.annotations.tags.Tags
-
An array of Tag annotation objects which hold metadata for the API
- value() - Method in annotation type io.swagger.v3.oas.annotations.Webhooks
-
An array of Webhook annotations
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.enums.Explode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.enums.ParameterIn
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.enums.ParameterStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.enums.SecuritySchemeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.media.Schema.AccessMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.media.Schema.AdditionalPropertiesValue
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.swagger.v3.oas.annotations.media.Schema.RequiredMode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.swagger.v3.oas.annotations.enums.Explode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.enums.ParameterIn
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.enums.ParameterStyle
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.enums.SecuritySchemeIn
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.enums.SecuritySchemeType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.media.Schema.AccessMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.media.Schema.AdditionalPropertiesValue
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.swagger.v3.oas.annotations.media.Schema.RequiredMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- variables() - Method in annotation type io.swagger.v3.oas.annotations.servers.Server
-
An array of variables used for substitution in the server's URL template.
- version() - Method in annotation type io.swagger.v3.oas.annotations.info.Info
-
The version of the API definition.
W
- Webhook - Annotation Type in io.swagger.v3.oas.annotations
-
The annotation may be used to define a method as an OpenAPI Webhook.
- Webhooks - Annotation Type in io.swagger.v3.oas.annotations
-
Container for repeatable
Webhook
annotation - WRITE_ONLY - io.swagger.v3.oas.annotations.media.Schema.AccessMode
- writeOnly() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Deprecated.As of 2.0.0, replaced by
Schema.accessMode()
_
- _const() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides value restricted to this schema.
- _else() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the else sub schema related to this schema
- _else() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the else sub schema related to this schema
- _if() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the if sub schema related to this schema
- _if() - Method in annotation type io.swagger.v3.oas.annotations.media.Schema
-
Provides the if sub schema related to this schema
- _then() - Method in annotation type io.swagger.v3.oas.annotations.media.Content
-
Provides the then sub schema related to this schema
All Classes All Packages