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
Copy file name to clipboardExpand all lines: versions/2.0.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,7 +140,7 @@ Field Pattern | Type | Description
140
140
---|:---:|---
141
141
<aname="operationExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
142
142
143
-
##### Object Example:
143
+
##### Info Object Example:
144
144
145
145
```js
146
146
{
@@ -186,7 +186,7 @@ Field Name | Type | Description
186
186
<a name="contactUrl"></a>url | `string` | The URL pointing to the contact information. MUST be in the format of a URL.
187
187
<a name="contactEmail"></a>email | `string` | The email address of the contact person/organization. MUST be in the format of an email address.
188
188
189
-
##### Object Example:
189
+
##### Contact Object Example:
190
190
191
191
```js
192
192
{
@@ -213,7 +213,7 @@ Field Name | Type | Description
213
213
<a name="licenseName"></a>name | `string` | **Required.** The license name used for the API.
214
214
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL.
215
215
216
-
##### Object Example:
216
+
##### License Object Example:
217
217
218
218
```js
219
219
{
@@ -239,7 +239,7 @@ Field Pattern | Type | Description
239
239
<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`](#swaggerBasePath) in order to construct the full URL. [Path templating](#pathTemplating) is allowed.
240
240
<a name="pathsExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
241
241
242
-
##### Object Example
242
+
##### Paths Object Example
243
243
244
244
```js
245
245
{
@@ -305,7 +305,7 @@ Field Pattern | Type | Description
305
305
---|:---:|---
306
306
<a name="pathItemExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
307
307
308
-
##### Object Example
308
+
##### Path Item Object Example
309
309
310
310
```js
311
311
{
@@ -408,7 +408,7 @@ Field Pattern | Type | Description
408
408
---|:---:|---
409
409
<a name="operationExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
410
410
411
-
##### Object Example
411
+
##### Operation Object Example
412
412
413
413
```js
414
414
{
@@ -517,7 +517,7 @@ Field Name | Type | Description
517
517
<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
518
518
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
519
519
520
-
##### Object Example
520
+
##### External Documentation Object Example
521
521
522
522
```js
523
523
{
@@ -589,7 +589,7 @@ Field Pattern | Type | Description
589
589
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
590
590
591
591
592
-
##### Object Example
592
+
##### Parameter Object Examples
593
593
594
594
###### Body Parameters
595
595
@@ -762,7 +762,7 @@ Field Name | Type | Description
762
762
<a name="itemsEnum"></a>enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76.
763
763
<a name="itemsMultipleOf"></a>multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14.
764
764
765
-
##### Object Example
765
+
##### Items Object Examples
766
766
767
767
Items must be of type string and have the minimum length of 2 characters:
768
768
@@ -819,7 +819,7 @@ Field Pattern | Type | Description
819
819
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
820
820
821
821
822
-
##### Object Example
822
+
##### Responses Object Example
823
823
824
824
A 200 response for successful operation and a default response for others (implying an error):
825
825
@@ -862,7 +862,7 @@ Field Name | Type | Description
862
862
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
863
863
<a name="responseExamples"></a>examples | [Example Object](#exampleObject) | An example of the response message.
864
864
865
-
##### Object Example
865
+
##### Response Object Examples
866
866
867
867
Response of an array of a complex type:
868
868
@@ -964,7 +964,7 @@ Field Pattern | Type | Description
964
964
---|:---:|---
965
965
<a name="headersName"></a>{name} | [Header Object](#headerObject) | The name of the property corresponds to the name of the header. The value describes the type of the header.
966
966
967
-
##### Object Example
967
+
##### Headers Object Example
968
968
969
969
Rate-limit headers:
970
970
@@ -1006,7 +1006,7 @@ Field Pattern | Type | Description
1006
1006
---|:---:|---
1007
1007
<a name="exampleMimeType"></a>{[mime type](#mimeTypes)} | Any | The name of the property MUST be one of the Operation `produces` values (either implicit or inherited). The value SHOULD be an example of what such a response would look like.
1008
1008
1009
-
##### Object Example
1009
+
##### Example Object Example
1010
1010
1011
1011
Example response for application/json mimetype of a Pet data type:
1012
1012
@@ -1054,7 +1054,7 @@ Field Name | Type | Description
1054
1054
<a name="headerEnum"></a>enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76.
1055
1055
<a name="headerMultipleOf"></a>multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14.
1056
1056
1057
-
##### Object Example
1057
+
##### Header Object Example
1058
1058
1059
1059
A simple header with of an integer type:
1060
1060
@@ -1086,7 +1086,7 @@ Field Pattern | Type | Description
1086
1086
---|:---:|---
1087
1087
<a name="tagExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
1088
1088
1089
-
##### Object Example
1089
+
##### Tag Object Example
1090
1090
1091
1091
```js
1092
1092
{
@@ -1109,7 +1109,7 @@ Field Name | Type | Description
1109
1109
---|:---:|---
1110
1110
<a name="referenceRef"></a>$ref | `string` | **Required.** The reference string.
1111
1111
1112
-
##### Object Example
1112
+
##### Reference Object Example
1113
1113
1114
1114
```js
1115
1115
{
@@ -1174,7 +1174,7 @@ While composition offers model extensibility, it does not imply a hierarchy betw
1174
1174
1175
1175
The [xml](#schemaXml) property allows extra definitions when translating the JSON definition to XML. The [XML Object](#xmlObject) contains additional information about the available options.
1176
1176
1177
-
##### Object Example
1177
+
##### Schema Object Examples
1178
1178
1179
1179
###### Primitive Sample
1180
1180
@@ -1503,7 +1503,7 @@ Field Name | Type | Description
1503
1503
<a name="xmlAttribute"></a>attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`.
1504
1504
<a name="xmlWrapped"></a>wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, `<books><book/><book/></books>`) or unwrapped (`<book/><book/>`). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`).
1505
1505
1506
-
##### Object Example
1506
+
##### XML Object Examples
1507
1507
1508
1508
The examples of the XML object definitions are included inside a property definition of a [Schema Object](#schemaObject) with a sample of the XML representation of it.
1509
1509
@@ -1848,7 +1848,7 @@ Field Pattern | Type | Description
1848
1848
---|:---:|---
1849
1849
<a name="definitionsName"></a>{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines.
1850
1850
1851
-
##### Object Example
1851
+
##### Definitions Object Example
1852
1852
1853
1853
```js
1854
1854
{
@@ -1906,7 +1906,7 @@ Field Pattern | Type | Description
1906
1906
---|:---:|---
1907
1907
<a name="pdName"></a>{name} | [Parameter Object](#parameterObject) | A single parameter definition, mapping a "name" to the parameter it defines.
1908
1908
1909
-
##### Object Example
1909
+
##### Parameters Definition Object Example
1910
1910
1911
1911
```js
1912
1912
{
@@ -1959,7 +1959,7 @@ Field Pattern | Type | Description
1959
1959
---|:---:|---
1960
1960
<a name="rdName"></a>{name} | [Response Object](#responseObject) | A single response definition, mapping a "name" to the response it defines.
1961
1961
1962
-
##### Object Example
1962
+
##### Responses Definitions Object Example
1963
1963
1964
1964
```js
1965
1965
{
@@ -1998,7 +1998,7 @@ Field Pattern | Type | Description
1998
1998
---|:---:|---
1999
1999
<a name="sdName"></a>{name} | [Security Scheme Object](#securitySchemeObject) | A single security scheme definition, mapping a "name" to the scheme it defines.
2000
2000
2001
-
##### Object Example
2001
+
##### Security Definitions Object Example
2002
2002
2003
2003
```js
2004
2004
{
@@ -2055,7 +2055,7 @@ Field Name | Type | Description
2055
2055
---|:---:|---
2056
2056
<a name="securitySchemeExtensions"></a>^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#vendorExtensions) for further details.
2057
2057
2058
-
##### Object Example
2058
+
##### Security Scheme Object Example
2059
2059
2060
2060
###### Basic Authentication Sample
2061
2061
@@ -2118,7 +2118,7 @@ Field Pattern | Type | Description
2118
2118
---|:---:|---
2119
2119
<a name="scopesName"></a>{name} | `string` | Maps between a name of a scope to a short description of it (as the value of the property).
2120
2120
2121
-
##### Object Example
2121
+
##### Scopes Object Example
2122
2122
2123
2123
```js
2124
2124
{
@@ -2144,7 +2144,7 @@ Field Pattern | Type | Description
2144
2144
---|:---:|---
2145
2145
<a name="securityRequirementsName"></a>{name} | [`string`] | Each name must correspond to a security scheme which is declared in the [Security Definitions](#securityDefinitions). If the security scheme is of type `"oauth2"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.
0 commit comments