OpenApiSpex.Response (open_api_spex v3.10.0) View Source

Defines the OpenApiSpex.Response.t type.

Link to this section Summary

Types

t()

Link to this section Types

t()

Specs

t() :: %OpenApiSpex.Response{
  content: %{required(String.t()) => OpenApiSpex.MediaType.t()} | nil,
  description: String.t(),
  headers:
    %{
      required(String.t()) => OpenApiSpex.Header.t() | OpenApiSpex.Reference.t()
    }
    | nil,
  links:
    %{required(String.t()) => OpenApiSpex.Link.t() | OpenApiSpex.Reference.t()}
    | nil
}

Response Object

Describes a single response from an API Operation, including design-time, static links to operations based on the response.