Skip to content

Commit ab6f58a

Browse files
committed
reviewed, cleaned up operation object docs
1 parent c306532 commit ab6f58a

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
@@ -419,7 +419,7 @@ Field Name | Type | Description
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.
421421
<a name="pathItemTrace"></a>trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path.
422-
<a name="pathItemServer"></a>[Server Object](#serverObject) | An alternative `server` object to service this operation.
422+
<a name="pathItemServer"></a>[Server Object](#serverObject) | An alternative `server` object to service all operations in this path.
423423
<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).
424424

425425

@@ -526,9 +526,7 @@ Field Name | Type | Description
526526
<a name="operationSchemes"></a>schemes | [`string`] | The transfer protocol for the operation. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. The value overrides the OpenAPI Object [`schemes`](#oasSchemes) definition.
527527
<a name="operationDeprecated"></a>deprecated | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is `false`.
528528
<a name="operationSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used.
529-
<a name="operationHost"></a>host | `string` | The host (name or ip) serving the path. This optional value will override the top-level [host](#oasHost) or path item-level [host](#pathItemHost). 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).
530-
<a name="operationBasePath"></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) or path item-level [basePath](#oasPathItemBasePath) 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).
531-
<a name="operationSchemes"></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) or path-item level [schemes](#pathItemSchemes) if present. If the `schemes` is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.
529+
<a name="operationItemServer"></a>[Server Object](#serverObject) | An alternative `server` object to service this operation. If an alternative `server` object is specified at the Path Item Object or Root level, it will be overridden by this value.
532530

533531
This object can be extended with [Specification Extensions](#specificationExtensions).
534532

@@ -600,7 +598,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
600598
tags:
601599
- pet
602600
summary: Updates a pet in the store with form data
603-
description: ""
601+
description: ''
604602
operationId: updatePetWithForm
605603
parameters:
606604
- name: petId

0 commit comments

Comments
 (0)