You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -262,8 +317,8 @@ An object representing a Server.
262
317
263
318
Field Name | Type | Description
264
319
---|:---:|---
265
-
<a name="serverUrlTemplate"></a>server URL template | `string` | A URL to the target host. This URL supports template variables and may be relative, to indicate that the host ___location is relative to the ___location where the OpenAPI Specification is being served. Templates are _optional_ and specified by the [#hostTemplateParameter] syntax. Template substitutions will be made when a variable is named in `{`brackets`}`.
266
-
<a name="hostDescription"></a>host description | `string` | An optional string describing the host designated by the URL.
320
+
<a name="serverUrlTemplate"></a>url | `string` | A URL to the target host. This URL supports template variables and may be relative, to indicate that the host ___location is relative to the ___location where the OpenAPI Specification is being served. Templates are _optional_ and specified by the [Host Template Parameter](#hostTemplateParameter) syntax. Template substitutions will be made when a variable is named in `{`brackets`}`.
321
+
<a name="hostDescription"></a>description | `string` | An optional string describing the host designated by the URL.
267
322
<a name="hostTemplates"></a>templates | [Templates Object](#hostTemplatesObject) | An object holding templates for substitution in the URL template
268
323
269
324
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -345,14 +400,14 @@ Field Pattern | Type | Description
345
400
#### <a name="pathsObject"></a>Paths Object
346
401
347
402
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).
403
+
The path is appended to the [`Server Object`](#serverObject) in order to construct
404
+
the full URL. The Paths may be empty, due to [ACL constraints](#securityFiltering).
350
405
351
406
##### Patterned Fields
352
407
353
408
Field Pattern | Type | Description
354
409
---|:---:|---
355
-
<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.
410
+
<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.
356
411
357
412
This object can be extended with [Specification Extensions](#specificationExtensions).
358
413
@@ -418,9 +473,8 @@ Field Name | Type | Description
418
473
<a name="pathItemOptions"></a>options | [Operation Object](#operationObject) | A definition of a OPTIONS operation on this path.
419
474
<a name="pathItemHead"></a>head | [Operation Object](#operationObject) | A definition of a HEAD operation on this path.
420
475
<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.
476
+
<a name="pathItemTrace"></a>trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path.
477
+
<a name="pathItemServer"></a>servers | [Server Object](#serverObject) | An alternative `server` array to service all operations in this path.
424
478
<a name="pathItemParameters"></a>parameters | [[Parameter Object](#parameterObject) <span>|</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).
425
479
426
480
@@ -524,12 +578,9 @@ Field Name | Type | Description
524
578
<a name="operationRequestBody"></a>requestBody | [[Request Body Object](#requestBodyObject) <span>|</span> [Reference Object](#referenceObject)] | The request body applicable for this operation.
525
579
<a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation.
526
580
<a name="operationCallbacks"></a>callback responses | [Callback Responses Object](#callbackObject) | The list of possible callback responses as they are returned from executing this operation.
527
-
<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.
528
581
<a name="operationDeprecated"></a>deprecated | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is `false`.
529
582
<a name="operationSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used.
530
-
<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).
531
-
<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).
532
-
<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.
583
+
<a name="operationItemServer"></a>servers | [Server Object](#serverObject) | An alternative `server` array 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.
533
584
534
585
This object can be extended with [Specification Extensions](#specificationExtensions).
535
586
@@ -553,19 +604,21 @@ This object can be extended with [Specification Extensions](#specificationExtens
553
604
}
554
605
],
555
606
"requestBody" : {
556
-
"content": {
557
-
"application/x-www-form-urlencoded":{
558
-
"schema": {
559
-
"type": "object",
607
+
"content": {
608
+
"application/x-www-form-urlencoded":{
609
+
"schema": {
610
+
"type": "object",
560
611
"properties": {
561
-
"name"
562
-
"description": "Updated name of the pet",
612
+
"name": {
613
+
"description": "Updated name of the pet",
563
614
"type": "string"
564
-
"status":
565
-
"description" : "Updated status of the pet",
615
+
},
616
+
"status": {
617
+
"description": "Updated status of the pet",
566
618
"type": "string"
619
+
}
567
620
},
568
-
"required": ["status"]
621
+
"required": ["status"]
569
622
}
570
623
}
571
624
}
@@ -601,7 +654,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
601
654
tags:
602
655
- pet
603
656
summary: Updates a pet in the store with form data
0 commit comments