All Classes and Interfaces

Class	Description
APIResponse	The APIResponse annotation corresponds to the OpenAPI Response model object which describes a single response from an API Operation, including design-time, static links to operations based on the response.
APIResponse	This interface represents a single response from an API Operation, including design-time, static links to operations based on the response.
APIResponses	The ApiResponses annotation is a container for @ApiResponse annotations.
APIResponses	This interface represents the container for the expected responses of an operation.
APIResponseSchema	The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which describes a single response from an API Operation.
Callback	This object represents a callback URL that will be invoked.
Callback	Callback
CallbackOperation	Describes a single API callback operation.
Callbacks	This object represents an array of Callback URLs that can be invoked.
Components	Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).
Components	Components
Constructible	Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
Contact	Contact information for the exposed API.
Contact	This interface represents the Contact information for the exposed API.
Content	This object provides schema and examples for a particular media type.
Content	Content
Discriminator	Discriminator
DiscriminatorMapping	This object maps payload values to a particular Schema.
Encoding	Single encoding definition to be applied to single Schema Object
Encoding	Encoding
Encoding.Style
Example	Example
ExampleObject	This object illustrates an example of a particular content
Explode	Enumeration used to define the value of Explode property.
Extensible<T extends Extensible<T>>	The base interface for OpenAPI model objects that can contain extensions.
Extension	A named extension that should be added to the OpenAPI definition.
Extensions	This object represents an array of extensions that can be added to the element.
ExternalDocumentation	This annotation allows referencing an external resource for extended documentation.
ExternalDocumentation	ExternalDocumentation
Header	Describes a single header object
Header	Header
Header.Style	Controls the style of serialization.
Info	This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
Info	This interface represents all the metadata about the API.
License	License information for the exposed API.
License	This interface represents the License information for the exposed API.
Link	The Link object represents a possible design-time link for a response.
Link	Link
LinkParameter	Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
MediaType	MediaType
OASConfig	Configurable properties in MicroProfile OpenAPI
OASFactory	This class allows application developers to build new OpenAPI model elements.
OASFactoryResolver	This class is not intended to be used by end-users.
OASFilter	This interface allows application developers to filter different parts of the OpenAPI model tree.
OASModelReader	This interface allows application developers to programmatically contribute an OpenAPI model tree.
OAuthFlow	Configuration details for a supported OAuth Flow.
OAuthFlow	Configuration details for a supportde OAuthFlow
OAuthFlows	Allows configuration of the supported OAuth Flows.
OAuthFlows	Configuration of the supported OAuthFlows
OAuthScope	Represents an OAuth scope.
OpenAPI	OpenAPI
OpenAPIDefinition	OpenAPI
Operation	Describes a single API operation on a path.
Operation	Operation
Parameter	Describes a single operation parameter
Parameter	Parameter
Parameter.In	The values allowed for the in field.
Parameter.Style	The values allowed for the style field.
ParameterIn
Parameters	This object encapsulates input parameters
ParameterStyle
PathItem	PathItem
PathItem.HttpMethod	All of the possible types of HTTP operations for this path
Paths	Paths
Reference<T extends Reference<T>>	Base interface for OpenAPI model objects that can make reference to other objects.
RequestBody	Describes a single request body.
RequestBody	This interface represents the request body of an operation in which body parameters can be specified.
RequestBodySchema	Provides a reference to a class that (after introspection) describes the schema for a single request body.
Schema	The Schema Object allows the definition of input and output data types.
Schema	The Schema Object allows the definition of input and output data types.
Schema.False	Marker class for use in additionalProperties to indicate that the corresponding schema's additionalPropertiesBoolean value is to be set to boolean false.
Schema.SchemaType	The values allowed for the in field.
Schema.True	Marker class for use in additionalProperties to indicate that the corresponding schema's additionalPropertiesBoolean value is to be set to boolean true.
SchemaProperty	The SchemaProperty Object allows the definition of input and output data types nested within the properties attribute of a Schema annotation.
SchemaType
SecurityRequirement	Specifies a security requirement for an operation.
SecurityRequirement	SecurityRequirement
SecurityRequirements	Container annotation for repeated SecurityRequirement annotations.
SecurityRequirementsSet	This annotation represents a set of security requirements which permit access to an operation if all of them are satisfied.
SecurityRequirementsSets	Represents an array of security requirement sets that apply to an operation.
SecurityScheme	Defines a security scheme that can be used by the operations.
SecurityScheme	SecurityScheme
SecurityScheme.In	In is a REQUIRED property that specifies the location of the API key.
SecurityScheme.Type	Type is a REQUIRED property that specifies the type of SecurityScheme instance.
SecuritySchemeIn
SecuritySchemes	This object represents an array of SecurityScheme annotations that can be specified at the definition level.
SecuritySchemeType
Server	This annotation represents a Server used in an operation or used by all operations in an OpenAPI document.
Server	An object representing a server.
Servers	The Servers annotation is a container for @Server annotations.
ServerVariable	An object representing a Server Variable for server URL template substitution.
ServerVariable	An object representing a Server Variable for server URL template substitution.
Tag	This object represents a tag.
Tag	Tag
Tags	The Tags annotation is a container for @Tag annotations.
XML	A metadata object that allows for more fine-tuned XML model definitions.