OpenApiSpex.Encoding (open_api_spex v3.10.0) View Source

Defines the OpenApiSpex.Encoding.t type.

Link to this section Summary

Types

t()

Link to this section Types

t()

Specs

t() :: %OpenApiSpex.Encoding{
  allowReserved: boolean() | nil,
  contentType: String.t() | nil,
  explode: boolean() | nil,
  headers:
    %{
      required(String.t()) => OpenApiSpex.Header.t() | OpenApiSpex.Reference.t()
    }
    | nil,
  style: OpenApiSpex.Parameter.style() | nil
}

Encoding Object

A single encoding definition applied to a single schema property.