OasHeader

Data about OasHeader. The OasHeader object follows the structure of the OasParameter object with the following changes:

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

Members

Variables

allowEmptyValue
bool allowEmptyValue;

Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.

deprecated_
bool deprecated_;

Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.

description
string description;

A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.

ref_
string ref_;

A link to parameters defined in the [OasDocument's] components/references.

required
bool required;

Determines whether this header is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.

Meta