Skip navigation links
A C D E H I L O P R S T V 

A

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
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.

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
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.
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() or ApiResponse.content().

D

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.

E

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()
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() or Content.examples()
Explode - Enum in io.swagger.v3.oas.annotations.enums
 
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 - Annotation Type in io.swagger.v3.oas.annotations.extensions
Container for repeatable Extension annotation
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).

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() or Content.encoding().
Hidden - Annotation Type in io.swagger.v3.oas.annotations
Marks a given resource, class or bean type as hidden, skipping while reading / resolving

I

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
 

L

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.

O

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.
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.
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.

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 - Annotation Type in io.swagger.v3.oas.annotations
Container for repeatable Parameter annotation
ParameterStyle - Enum in io.swagger.v3.oas.annotations.enums
 
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.

R

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.

S

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 - 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
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 - 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 - 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.

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 - Annotation Type in io.swagger.v3.oas.annotations.tags
Container for repeatable Tag annotation
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
 

V

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.
A C D E H I L O P R S T V 
Skip navigation links

Copyright © 2022. All rights reserved.