Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations

Annotations
@Version:1.2
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:

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 Summary

Modifier and TypeAnnotation and Description
public @interface
Components

Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).

public @interface
ExternalDocumentation

This annotation allows referencing an external resource for extended documentation.

public @interface
OpenAPIDefinition

OpenAPI

This is the root document object of the OpenAPI document.

public @interface
Operation

Describes a single API operation on a path.

public @interface
PathItem

Describes a set of operations available on a single path.

public @interface
PathItemOperation

Describes an Operation

This annotation is only used for operations defined under a PathItem.