Documentation update #817
Merged
Documentation update #817
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@OAI/tdc Please review and approve |
ePaul
suggested changes
Oct 25, 2016
| @@ -345,14 +345,14 @@ Field Pattern | Type | Description | |||
| #### <a name="pathsObject"></a>Paths Object | |||
|
|
|||
| Holds the relative paths to the individual endpoints. | |||
| The path is appended to the [`basePath`](#oasBasePath) in order to construct the full URL. | |||
| The Paths may be empty, due to [ACL constraints](#securityFiltering). | |||
| The path is appended to the [`Server Object`](#serverObject) in order to construct | |||
There was a problem hiding this comment.
Hmm, not sure how one can append a path (string) to an object. Maybe you want something like this?
The path is appended to the base path build from the server object.
|
|
||
| ##### Patterned Fields | ||
|
|
||
| Field Pattern | Type | Description | ||
| ---|:---:|--- | ||
| <a name="pathsPath"></a>/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the [`basePath`](#oasBasePath) in order to construct the full URL. [Path templating](#pathTemplating) is allowed. | ||
| <a name="pathsPath"></a>/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the [`Server Object`](#serverObject) in order to construct the full URL. [Path templating](#pathTemplating) is allowed. |
| <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). | ||
| <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. | ||
| <a name="pathItemTrace"></a>trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path. | ||
| <a name="pathItemServer"></a>[Server Object](#serverObject) | An alternative `server` object to service all operations in this path. |
There was a problem hiding this comment.
This field is missing a name?
fehguy
commented
Oct 28, 2016
| <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). | ||
| <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). | ||
| <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. | ||
| <a name="pathItemTrace"></a>trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path. |
There was a problem hiding this comment.
If trace has a fixed response, perhaps describing it here doesn't make sense, or we need to say that "if you use trace, you can't describe any response!?"
|
May remove |
AndersDJohnson
pushed a commit
to AndersDJohnson/OpenAPI-Specification
that referenced
this pull request
Apr 8, 2019
Documentation update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the following items from the #589 (comment) comment, with minor corrections and a general review: