Module neberus.core
Package net.oneandone.neberus.annotation

Annotation Type ApiResponse

  • @Target(METHOD)
@Retention(SOURCE)
@Repeatable(ApiResponses.class)
public @interface ApiResponse
    Document a Response.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String description
      Description of the response.
      ApiStatus status
      Status of the response.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      ApiEntity[] entities
      Entities used in this response.
      ApiHeader[] headers
      Headers used in this response.

    • Element Detail

      • status

        ApiStatus status
        Status of the response.
        Returns:
        the status

      • description

        java.lang.String description
        Description of the response.
        Returns:
        the description

      • entities

        ApiEntity[] entities
        Entities used in this response.
        Returns:
        the entities
        Default:
        {}

      • headers

        ApiHeader[] headers
        Headers used in this response.
        Returns:
        the headers
        Default:
        {}