Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.responses

Annotations
@Version:1.2
@ProviderType
Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation.

Example usage: 

@GET
 @Path("{id}")
 @APIResponse(
     responseCode="200",
     description="Review retrieved",
     content=@Content(
         schema=@Schema(
             implementation=Review.class))
 )

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
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.

public @interface
APIResponses

The ApiResponses annotation is a container for @ApiResponse annotations.

public @interface
APIResponseSchema

The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which describes a single response from an API Operation.