Skip to content

Commit 33e5b98

Browse files
committed
edit Parameter Locations and its Fixed Fields
1 parent e6ec613 commit 33e5b98

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

versions/3.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -954,7 +954,7 @@ Describes a single operation parameter.
954954
A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn).
955955

956956
##### Parameter Locations
957-
There are four possible parameter locations (as specified with the `in` field):
957+
There are four possible parameter locations specified by the `in` field:
958958
* path - Used together with [Path Templating](#pathTemplating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`.
959959
* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`.
960960
* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive.
@@ -964,7 +964,7 @@ There are four possible parameter locations (as specified with the `in` field):
964964
##### Fixed Fields
965965
Field Name | Type | Description
966966
---|:---:|---
967-
<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 based on the [`in`](#parameterIn) property.</ul>
967+
<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>
968968
<a name="parameterIn"></a>in | `string` | **REQUIRED**. The ___location of the parameter. Possible values are "query", "header", "path" or "cookie".
969969
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
970970
<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`.

0 commit comments

Comments
 (0)