All Classes

Class	Description
ApiResponse	The annotation may be used at method level or as field of Operation to define one or more responses of the Operation.
ApiResponses	Container for repeatable ApiResponse annotation
ArraySchema	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.
Callback	The annotation may be used at method level to add one ore more callbacks to the operation definition.
Callbacks	Container for repeatable Callback annotation
Contact	The annotation may be used in Info.contact() to define a contact for the OpenAPI spec.
Content	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().
DependentRequired	The annotation may be used to define dependent schemas for an Object Schema
DependentRequiredMap	Container for repeatable DependentRequired annotation
DependentSchema	The annotation may be used to define dependent schemas for an Object Schema
DependentSchemas	Container for repeatable DependentSchema annotation
DiscriminatorMapping	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.
Encoding	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	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
Extension	An optionally named list of extension properties.
ExtensionProperty	A name/value property within a OpenApi extension
Extensions	Container for repeatable Extension annotation
ExternalDocumentation	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).
Header	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	Marks a given resource, class or bean type as hidden, skipping while reading / resolving
Info	The annotation may be used in OpenAPIDefinition.info() to populate the Info section of the OpenAPI document.
License	The annotation may be used in Info.license() to define a license for the OpenAPI spec.
Link	The annotation may be applied in ApiResponse.links() to add OpenAPI links to a response.
LinkParameter	Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
OAuthFlow	Configuration details for a supported OAuth Flow.
OAuthFlows	Allows configuration of the supported OAuth Flows.
OAuthScope	Represents an OAuth scope.
OpenAPI31
OpenAPIDefinition	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	The annotation may be used to define a resource method as an OpenAPI Operation, and/or to define additional properties for the Operation.
Parameter	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
Parameters	Container for repeatable Parameter annotation
ParameterStyle
PatternProperties	Container for repeatable PatternProperty annotation
PatternProperty	The annotation may be used in OpenAPI 3.1 schemas / JSON Schema.
RequestBody	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.
Schema	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
Schema.AdditionalPropertiesValue
Schema.RequiredMode
SchemaProperties	Container for repeatable SchemaProperty annotation
SchemaProperty	The annotation may be used to define properties for an Object Schema
SecurityRequirement	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	Container for repeatable SecurityRequirement annotation
SecurityScheme	The annotation may be used at class level (also on multiple classes) to add securitySchemes to spec components section.
SecuritySchemeIn
SecuritySchemes	Container for repeatable SecurityScheme annotation
SecuritySchemeType
Server	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	Container for repeatable Server annotation
ServerVariable	An object representing a Server Variable for server URL template substitution.
StringToClassMapItem
Tag	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	Container for repeatable Tag annotation
Webhook	The annotation may be used to define a method as an OpenAPI Webhook.
Webhooks	Container for repeatable Webhook annotation