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
An object representing a Server Variable for server URL template substituion.
388
+
An object representing a Server Variable for server URL template substitution.
389
+
390
+
##### Fixed Fields
389
391
390
392
Field Name | Type | Description
391
393
---|:---:|---
@@ -410,7 +412,7 @@ Field Name | Type | Description
410
412
<a name="componentsParameters"></a> parameters | Map[`string`, [Parameter Object](#parameterObject)] | An object to hold reusable [Parameter Objects](#parameterObject).
411
413
<a name="componentsExamples"></a> examples | Map[`string`, [Example Object](#exampleObject)] | An object to hold reusable [Example Objects](#exampleObject).
412
414
<a name="componentsRequestBodies"></a> requestBodies | Map[`string`, [Request Body Object](#requestBodyObject)] | An object to hold reusable [Request Body Objects](#requestBodyObject).
413
-
<a name="componentsHeaders"></a> headers | Map[`string`, [Header object](#headerObject)] | An object to hold reusable [Header objects](#headerObject).
415
+
<a name="componentsHeaders"></a> headers | Map[`string`, [Header Object](#headerObject)] | An object to hold reusable [Header Objects](#headerObject).
414
416
<a name="componentsSecuritySchemes"></a> securitySchemes| Map[`string`, [Security Scheme Object](#securitySchemeObject)] | An object to hold reusable [Security Scheme Objects](#securitySchemeObject).
415
417
<a name="componentsLinks"></a> links | Map[`string`, [Link Object](#linkObject)] | An object to hold reusable [Link Objects](#linkObject).
416
418
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Objects](#callbackObject).
@@ -912,6 +914,7 @@ Describes a single operation parameter.
912
914
913
915
A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn).
914
916
917
+
##### Parameter Locations
915
918
There are four possible parameter locations (as specified with the `in` field):
916
919
* 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`.
917
920
* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`.
@@ -927,7 +930,7 @@ Field Name | Type | Description
927
930
<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.
928
931
<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`.
929
932
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
930
-
<a name="parameterAllowEmptyValue"/>allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, if behavior is `n/a`, the value of `allowEmptyValue` SHALL be ignored.
933
+
<a name="parameterAllowEmptyValue"/></a> allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, if behavior is `n/a`, the value of `allowEmptyValue` SHALL be ignored.
931
934
932
935
The rules for serialization of the parameter are specified in one of two ways.
933
936
For simpler scenarios, a [`style`](#parameterStyle) and [`schema`](#parameterSchema) can be used to describe the structure and syntax of the parameter.
@@ -951,6 +954,8 @@ Field Name | Type | Description
951
954
---|:---:|---
952
955
<a name="parameterContent"></a>content | [Content Object](#contentObject) | The content of the parameter.
953
956
957
+
##### Style Values
958
+
954
959
In order to support common ways of serializing simple parameters, a set of `style` values are defined.
@@ -1865,6 +1870,8 @@ The link SHALL reference a single Link Object, or a JSON Reference to a single l
1865
1870
#### <a name="linkObject"></a>Link Object
1866
1871
The `Link Object` is responsible for defining a possible operation based on a single response.
1867
1872
1873
+
##### Fixed Fields
1874
+
1868
1875
Field Name | Type | Description
1869
1876
---|:---:|---
1870
1877
href | `string` | a relative or absolute URL to a linked resource. This field is mutually exclusive with the `operationId` field.
@@ -2470,6 +2477,8 @@ This object is an extended subset of the [JSON Schema Specification Wright Draft
2470
2477
Further information about the properties can be found in [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00) and [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00).
2471
2478
Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
2472
2479
2480
+
##### Properties
2481
+
2473
2482
The following properties are taken directly from the JSON Schema definition and follow the same specifications:
0 commit comments