All Classes and Interfaces

Class
Description
Abstract base class for annotation scanners
Common parameter processing that may be customized by individual frameworks such as JAX-RS, Spring, Vert.x, etc.
Used for collecting and merging any scanned Parameter annotations with the framework-specific parameter annotations.
Key used to store AbstractParameterProcessor.ParameterContext objects in a map sorted by Parameter.In, then by name, nulls first.
 
This represent a scanner
Context for scanners.
Extension point for supporting extensions to OpenAPI Scanners.
 
Factory that allows plugging in more scanners.
Process annotation targets such as FieldInfo.
Warning this class consists of generated code.
An implementation of the APIResponse OpenAPI model interface.
An implementation of the APIResponses OpenAPI model interface.
IndexView augmented with additional methods for common operations used throughout the data object scanning code.
 
 
Constants related to Callback.
An implementation of the Callback OpenAPI model interface.
Reading the Callback annotation and json
Writing the Callback to json
Help to get a default classLoader
Constants related to Components.
An implementation of the Components OpenAPI model interface.
Reading the Components annotation and json node
Writing the Components to json node
Used to configure server information and some more from config properties.
Constants related to Contact
An implementation of the Contact OpenAPI model interface.
This reads the Contact from annotations or json
This write the Contact to json
Constants related to Content.
Simple enum to indicate whether an @Content annotation being processed is an input or an output.
An implementation of the Content OpenAPI model interface.
Reading the Content object annotation and json
Writing the Content to json
A simple registry that allows users to provide a custom schema for some types.
Deque for exploring object graph.
An entry on the object stack.
Warning this class consists of generated code.
Warning this class consists of generated code.
Constants related to Open API definition.
Reading the OpenAPIDefinition from an annotation or json
Writing the OpenAPIDefinition to json
Constants related to Discriminator.
An implementation of the Discriminator OpenAPI model interface.
Reading the Discriminator from an annotation or json
Writing the Discriminator to json
Constants related to Encoding.
An implementation of the Encoding OpenAPI model interface.
Reading the Encoding object annotation and json
Write the Encoding object to json
 
Constants related to Example.
An implementation of the Example OpenAPI model interface.
Reading the Example annotation
Writing the Example to json
ExtensibleImpl<T extends org.eclipse.microprofile.openapi.models.Extensible<T>>
Implementation of the Extensible OpenAPI model interface.
Constants related to Extension.
Reading the Extension annotation
Writing the Extension to json
Constants related to External Docs
This reads annotations and json for External Documentation
This writes External Documentation json
An implementation of the ExternalDocumentation OpenAPI model interface.
Wraps an IndexView instance and filters the contents based on the settings provided via OpenApiConfig.
 
 
 
An implementation of the Header OpenAPI model interface.
Reading the Header from annotations or json
Writing the Header to json
 
 
Constants related to Info
An implementation of the Info OpenAPI model interface.
This reads the Info from annotations or json
This write the Info to json
 
Warning this class consists of generated code.
Warning this class consists of generated code.
 
Constants related to the Jackson library
Some utility methods for working with Jandex objects.
Simple enum to indicate the type of a $ref being read/written.
This helps to apply java security (@RolesAllowed etc.).
Constants related to the JAXB Specification
Constants from the JDK
Constants related to the JSON-B Specification
Utilities methods for reading information from a Json Tree.
Constants related to the Kotlin language
Constants related to License
An implementation of the License OpenAPI model interface.
This reads the License from annotations or json
This writes the License to json
Constants related to Link
An implementation of the Link OpenAPI model interface.
Reading the Link annotation and json
Writing the Link to json
Util that helps with List operations
 
 
Constants related to MediaType
An implementation of the MediaType OpenAPI model interface.
Reading the Media type object annotation and json
Writer the Media type object to json
Used to merge OAI data models into a single one.
Marker interface - all data model implementations implement this interface.
Class with some convenience methods useful for working with the OAI data model.
 
An implementation of the OpenAPI 1.0 spec's OASFactoryResolver.
An implementation of the OAuthFlow OpenAPI model interface.
An implementation of the OAuthFlows OpenAPI model interface.
Reading the Oauth flow annotation
Writing the Security Scheme to json
 
Scans a deployment (using the archive and jandex annotation index) for OpenAPI annotations.
Accessor to OpenAPI configuration options.
 
 
 
Implementation of the OpenApiConfig interface that gets config information from a standard MP Config object.
 
Explores the class graph from the provided root, creating an OpenAPI Schema from the entities encountered.
Holds the final OpenAPI document produced during the startup of the app.
An implementation of the OpenAPI OpenAPI model interface.
A class used to parse an OpenAPI document (either YAML or JSON) into a Microprofile OpenAPI model tree.
Provides some core archive processing functionality.
RuntimeException to be thrown when fatal exceptions are detected in the Open API read/scan processes.
Class used to serialize an OpenAPI
 
Constants related to Operation
An implementation of the Operation OpenAPI model interface.
Reading the Operation from annotation or json
Writing the OperationWriter to json
Constants related to Parameter
An implementation of the Parameter OpenAPI model interface.
Constants related to Parameterizable contrants
Reading the Parameter annotation
Writing Parameter to json
An implementation of the PathItem OpenAPI model interface.
Constants related to Paths
An implementation of the Paths OpenAPI model interface.
Reading the Paths from annotation or json
Writing the Paths to json
 
Can be referenced
Constants related to RequestBody
An implementation of the RequestBody OpenAPI model interface.
Reading the RequestBody annotation
Writing the RequestBody to json
Result object returned to the annotation scanner.
Constants related to Response
Reading the APIResponse annotation
Writing the APIResponse to json
Warning this class consists of generated code.
Warning this class consists of generated code.
Warning this class consists of generated code.
Warning this class consists of generated code.
Constants related to Schema
 
An implementation of the Schema OpenAPI model interface.
Reading the Schema annotation
A simple registry used to track schemas that have been generated and inserted into the #/components section of the
This class is used as the key when storing Schemas in the registry.
Writing the Schema to json
Constants related to the Security annotations
Constants related to SecurityRequirement
An implementation of the SecurityRequirement OpenAPI model interface.
Reading the Security from annotations or json
Writing the Security requirement to json
Constants related to SecurityScheme
An implementation of the SecurityScheme OpenAPI model interface.
Reading the Security Scheme annotation
Writing the Security Scheme to json
Constants related to Server
An implementation of the Server OpenAPI model interface.
Reading the Server annotation and json node
Constants related to Server
An implementation of the ServerVariable OpenAPI model interface.
Reading the ServerVariable annotation and json node
Writing the ServerVariable to json
Writing the Server to json
Warning this class consists of generated code.
 
 
Constants related to Server
An implementation of the Tag OpenAPI model interface.
Reading the Tag from annotation or json
Writing the Tag to json
Parse a type signature String to a Jandex Type
Process Type instances.
 
 
 
Warning this class consists of generated code.
Warning this class consists of generated code.
Warning this class consists of generated code.
 
Constants related to XML
An implementation of the XML OpenAPI model interface.
Reading the Xml from annotation or json
Writing the Xml to json