open_api_spex v3.2.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()
View Source
t() :: %OpenApiSpex.Header{
allowEmptyValue: boolean() | nil,
deprecated: boolean() | nil,
description: String.t() | nil,
example: any(),
examples:
%{
optional(String.t()) =>
OpenApiSpex.Example.t() | OpenApiSpex.Reference.t()
}
| nil,
explode: boolean() | nil,
required: boolean() | nil,
schema: OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t() | nil,
style: :simple
}
t() :: %OpenApiSpex.Header{ allowEmptyValue: boolean() | nil, deprecated: boolean() | nil, description: String.t() | nil, example: any(), examples: %{ optional(String.t()) => OpenApiSpex.Example.t() | OpenApiSpex.Reference.t() } | nil, explode: boolean() | nil, required: boolean() | nil, schema: OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t() | nil, style: :simple }
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).