Package io.swagger.v3.oas.annotations.responses

Annotation Type FailedApiResponse

  • @Target({METHOD,TYPE,ANNOTATION_TYPE})
@Retention(RUNTIME)
public @interface FailedApiResponse
    A meta-annotation that bundles common error response definitions for API operations.

    Includes default definitions for:

    • 400 Bad Request
    • 401 Unauthorized
    • 403 Forbidden
    • 404 Not Found
    • 429 Too Many Requests
    • 500 Internal Server Error
    • 503 Service Unavailable
    Can be used at type level to apply to all operations in a controller, or at method level for individual operations.
    Since:
    2.2.32
    See Also:
    ApiResponse, ApiResponses

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Extension[] extensions
      The list of optional extensions.
      String ref
      A reference to a response definition in components responses.

    • Element Detail

      • ref

        String ref
        A reference to a response definition in components responses.
        Returns:
        the reference
        Since:
        2.2.32
        Default:
        ""

      • extensions

        Extension[] extensions
        The list of optional extensions.
        Returns:
        an optional array of extensions
        Since:
        2.2.32
        Default:
        {}