Skip to content

Commit effb92b

Browse files
authored
Merge branch 'v3.0.3-dev' into more-https
2 parents 1d24cc8 + 76f85e6 commit effb92b

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

versions/3.0.3.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1011,9 +1011,9 @@ There are four possible parameter locations specified by the `in` field:
10111011
Field Name | Type | Description
10121012
---|:---:|---
10131013
<a name="parameterName"></a>name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*. <ul><li>If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#pathsObject). See [Path Templating](#pathTemplating) for further information.<li>If [`in`](#parameterIn) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.<li>For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameterIn) property.</ul>
1014-
<a name="parameterIn"></a>in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
1014+
<a name="parameterIn"></a>in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`.
10151015
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
1016-
<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`.
1016+
<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`.
10171017
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`.
10181018
<a name="parameterAllowEmptyValue"></a> allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) 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.
10191019

@@ -1772,7 +1772,8 @@ Plain text response with headers:
17721772
"content": {
17731773
"text/plain": {
17741774
"schema": {
1775-
"type": "string"
1775+
"type": "string",
1776+
"example": "whoa!"
17761777
}
17771778
}
17781779
},
@@ -1837,7 +1838,7 @@ description: object created
18371838

18381839
A map of possible out-of band callbacks related to the parent operation.
18391840
Each value in the map is a [Path Item Object](#pathItemObject) that describes a set of requests that may be initiated by the API provider and the expected responses.
1840-
The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
1841+
The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
18411842

18421843
##### Patterned Fields
18431844
Field Pattern | Type | Description

0 commit comments

Comments
 (0)