open_api_spex v1.1.4 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() :: %OpenApiSpex.Response{content: %{optional(String.t()) => OpenApiSpex.MediaType.t()}, 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}

Response Object

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