Module org.eclipse.microprofile.openapi

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

@Version("1.2") @ProviderType package org.eclipse.microprofile.openapi.annotations.responses
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))
      )

Related Packages
Package
Description
org.eclipse.microprofile.openapi.annotations
A set of annotations, many derived from Swagger Core library.
Annotation Types
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.
APIResponses
The ApiResponses annotation is a container for @ApiResponse annotations.
APIResponseSchema
The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which describes a single response from an API Operation.