Package com.github.chhorz.openapi.common.annotation

Annotation Interface OpenAPIResponse

@Documented @Retention(SOURCE) @Target(ANNOTATION_TYPE) public @interface OpenAPIResponse
Structured annotation to document operation responses in a more structured way as the Javadoc tag @response.
Author:
chhorz

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Description of the response with the given status code and schema.
    Class<?>
    schema
    Class of the given response schema.
    String
    status
    The status code of the response.

  • Element Details

    • status

      String status
      The status code of the response. Must be a valid status code of three numbers or a range: 1XX, 2XX, 3XX, 4XX or 5XX which represents all status codes between 100 and 199 (https://spec.openapis.org/oas/v3.1.0#patterned-fields-0)

    • schema

      Class<?> schema
      Class of the given response schema.

    • description

      String description
      Description of the response with the given status code and schema.