open_api_spex v3.2.0 OpenApiSpex.Response View Source
Defines the OpenApiSpex.Response.t
type.
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %OpenApiSpex.Response{
content: %{optional(String.t()) => OpenApiSpex.MediaType.t()} | nil,
description: String.t(),
headers:
%{
optional(String.t()) => OpenApiSpex.Header.t() | OpenApiSpex.Reference.t()
}
| nil,
links:
%{optional(String.t()) => OpenApiSpex.Link.t() | OpenApiSpex.Reference.t()}
| nil
}
t() :: %OpenApiSpex.Response{ content: %{optional(String.t()) => OpenApiSpex.MediaType.t()} | nil, description: String.t(), headers: %{ optional(String.t()) => OpenApiSpex.Header.t() | OpenApiSpex.Reference.t() } | nil, links: %{optional(String.t()) => OpenApiSpex.Link.t() | OpenApiSpex.Reference.t()} | nil }
Describes a single response from an API Operation, including design-time, static links to operations based on the response.