open_api_spex v2.0.0 OpenApiSpex.Header View Source

Defines the OpenApiSpex.Header.t type.

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %OpenApiSpex.Header{
  allowEmptyValue: boolean(),
  deprecated: boolean(),
  description: String.t(),
  example: any(),
  examples: %{
    optional(String.t()) => OpenApiSpex.Example.t() | OpenApiSpex.Reference.t()
  },
  explode: boolean(),
  required: boolean(),
  schema: OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t(),
  style: :simple
}

Header Object

The Header Object follows the structure of the Parameter Object with the following changes:

  • name MUST NOT be specified, it is given in the corresponding headers map.
  • in MUST NOT be specified, it is implicitly in header.
  • All traits that are affected by the location MUST be applicable to a location of header (for example, style).