Skip to content

Commit d7e78ac

Browse files
committed
doc review for path item objects
1 parent 1b2b640 commit d7e78ac

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

versions/3.0.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -345,8 +345,8 @@ Field Pattern | Type | Description
345345
#### <a name="pathsObject"></a>Paths Object
346346

347347
Holds the relative paths to the individual endpoints.
348-
The path is appended to the [`basePath`](#oasBasePath) in order to construct the full URL.
349-
The Paths may be empty, due to [ACL constraints](#securityFiltering).
348+
The path is appended to the [`Server Object`](#serverObject) in order to construct
349+
the full URL. The Paths may be empty, due to [ACL constraints](#securityFiltering).
350350

351351
##### Patterned Fields
352352

@@ -418,9 +418,7 @@ Field Name | Type | Description
418418
<a name="pathItemOptions"></a>options | [Operation Object](#operationObject) | A definition of a OPTIONS operation on this path.
419419
<a name="pathItemHead"></a>head | [Operation Object](#operationObject) | A definition of a HEAD operation on this path.
420420
<a name="pathItemPatch"></a>patch | [Operation Object](#operationObject) | A definition of a PATCH operation on this path.
421-
<a name="pathItemHost"></a>host | `string` | The host (name or ip) serving the path. This optional value will override the top-level [host](#oasHost) if present. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the `host` is not included, the host serving the documentation is to be used (including the port). The `host` does not support [path templating](#pathTemplating).
422-
<a name="pathItemBasePath"></a>basePath | `string` | The base path on which the API is served, which is relative to the [`host`](#pathItemHost). This optional value will override the top-level [basePath](#oasBasePath) if present. If it is not included, the API is served directly under the `host`. The value MUST start with a leading slash (`/`). The `basePath` does not support [path templating](#pathTemplating).
423-
<a name="pathItemSchemes"></a>schemes | [`string`] | The transfer protocol of the API. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. This optional value will override the top-level [schemes](#oasSchemes) if present. If the `schemes` is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
421+
<a name="pathItemServer"></a>[Server Object](#serverObject) | An alternative `server` object to service this operation.
424422
<a name="pathItemParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>&#124;</span> [Reference Object](#referenceObject)] | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's parameters](#oasParameters).
425423

426424

0 commit comments

Comments
 (0)