Skip to content

Commit

Permalink
Merge pull request #3919 from handrews/ext-304
Browse files Browse the repository at this point in the history
Consisent x- Param/Encoding/Header wording (3.0.4)
  • Loading branch information
ralfhandl committed Jun 18, 2024
2 parents d16e7ef + eabf995 commit 936f8a5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions versions/3.0.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -1108,8 +1108,6 @@ The rules for serialization of the parameter are specified in one of two ways.
Parameter Objects MUST include either a `content` field or a `schema` field, but not both.
See [Appendix B](#dataTypeConversion) for a discussion of converting values of various types to string representations.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

###### Common Fixed Fields

These fields MAY be used with either `content` or `schema`.
Expand All @@ -1123,6 +1121,8 @@ Field Name | Type | Description
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`.
<a name="parameterAllowEmptyValue"></a> allowEmptyValue | `boolean` | If `true`, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is `false`. If [`style`](#parameterStyle) is used, and if [behavior is _n/a_ (cannot be serialized)](#style-examples), the value of `allowEmptyValue` SHALL be ignored. Interactions between this field and the parameter's [Schema Object](#schemaObject) are implementation-defined. This field is valid only for `query` parameters. Use of this property is NOT RECOMMENDED, and it is likely to be removed in a later revision.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

Note that while `"Cookie"` as a `name` is not forbidden with `in: header`, the effect of defining a cookie parameter that way is undefined; use `in: cookie` instead.

###### Fixed Fields for use with `schema`
Expand Down Expand Up @@ -2493,6 +2493,8 @@ Field Name | Type | Description
<a name="headerRequired"></a>required | `boolean` | Determines whether this header is mandatory. The default value is `false`.
<a name="headerDeprecated"></a> deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

##### Fixed Fields for use with `schema`

For simpler scenarios, a [`schema`](#headerSchema) and [`style`](#headerStyle) can describe the structure and syntax of the header.
Expand Down

0 comments on commit 936f8a5

Please sign in to comment.