Module org.eclipse.microprofile.openapi

@Version("1.2")

# Package org.eclipse.microprofile.openapi.annotations

A set of annotations, many derived from Swagger Core library. OpenAPI annotations can be augmented with existing Jakarta REST annotations in an application to produce a valid OpenAPI document. Examples of annotations in this package include:

- Components
- ExternalDocumentation
- OpenAPIDefinition
- Operation

Example of usage:

      @GET
      @Path("/findByStatus")
      @Operation(summary = "Finds Pets by status",
                description = "Multiple status values can be provided with comma separated strings")
      public Response findPetsByStatus(...) { ... }

Annotation Types Summary
Components: Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).
ExternalDocumentation: This annotation allows referencing an external resource for extended documentation.
OpenAPIDefinition: OpenAPI
Operation: Describes a single API operation on a path.
PathItem: Describes a set of operations available on a single path.
PathItemOperation: Describes an Operation