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
+60-4Lines changed: 60 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -120,6 +120,11 @@ Field Name | Type | Description
120
120
<aname="swaggerTags"></a>tags | [[Tag Object](#tagObject)] | A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the [Operation Object](#operationObject) must be declared. The tags that are not declared may be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
<aname="swaggerExtensions"></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.
123
128
124
129
#### <aname="infoObject"></a>Info Object
125
130
@@ -188,6 +193,12 @@ Field Name | Type | Description
188
193
<a name="contactUrl"></a>url | `string` | The URL pointing to the contact information. MUST be in the format of a URL.
189
194
<a name="contactEmail"></a>email | `string` | The email address of the contact person/organization. MUST be in the format of an email address.
190
195
196
+
##### Patterned Objects
197
+
198
+
Field Pattern | Type | Description
199
+
---|:---:|---
200
+
<a name="contactExtensions"></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.
201
+
191
202
##### Contact Object Example:
192
203
193
204
```js
@@ -215,6 +226,12 @@ Field Name | Type | Description
215
226
<a name="licenseName"></a>name | `string` | **Required.** The license name used for the API.
216
227
<a name="licenseUrl"></a>url | `string` | A URL to the license used for the API. MUST be in the format of a URL.
217
228
229
+
##### Patterned Objects
230
+
231
+
Field Pattern | Type | Description
232
+
---|:---:|---
233
+
<a name="licenseExtensions"></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.
234
+
218
235
##### License Object Example:
219
236
220
237
```js
@@ -519,6 +536,12 @@ Field Name | Type | Description
519
536
<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.
520
537
<a name="externalDocUrl"></a>url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL.
521
538
539
+
##### Patterned Objects
540
+
541
+
Field Pattern | Type | Description
542
+
---|:---:|---
543
+
<a name="externalDocExtensions"></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.
544
+
522
545
##### External Documentation Object Example
523
546
524
547
```js
@@ -765,6 +788,12 @@ Field Name | Type | Description
765
788
<a name="itemsEnum"></a>enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76.
766
789
<a name="itemsMultipleOf"></a>multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14.
767
790
791
+
##### Patterned Objects
792
+
793
+
Field Pattern | Type | Description
794
+
---|:---:|---
795
+
<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.
796
+
768
797
##### Items Object Examples
769
798
770
799
Items must be of type string and have the minimum length of 2 characters:
@@ -864,7 +893,12 @@ Field Name | Type | Description
864
893
<a name="responseSchema"></a>schema | [Schema Object](#schemaObject) | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the [Schema Object](#schemaObject), its root `type` value may also be `"file"`. This SHOULD be accompanied by a relevant `produces` mime-type.
865
894
<a name="responseHeaders"></a>headers | [Headers Object](#headersObject) | A list of headers that are sent with the response.
866
895
<a name="responseExamples"></a>examples | [Example Object](#exampleObject) | An example of the response message.
867
-
<a name="responseExtensions"></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.
896
+
897
+
##### Patterned Objects
898
+
899
+
Field Pattern | Type | Description
900
+
---|:---:|---
901
+
<a name="responseExtensions"></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.
868
902
869
903
##### Response Object Examples
870
904
@@ -967,7 +1001,7 @@ Lists the headers that can be sent as part of a response.
967
1001
Field Pattern | Type | Description
968
1002
---|:---:|---
969
1003
<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.
970
-
<a name="headersExtensions"></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.
1004
+
971
1005
##### Headers Object Example
972
1006
973
1007
Rate-limit headers:
@@ -1058,6 +1092,12 @@ Field Name | Type | Description
1058
1092
<a name="headerEnum"></a>enum | [*] | See http://json-schema.org/latest/json-schema-validation.html#anchor76.
1059
1093
<a name="headerMultipleOf"></a>multipleOf | `number` | See http://json-schema.org/latest/json-schema-validation.html#anchor14.
1060
1094
1095
+
##### Patterned Objects
1096
+
1097
+
Field Pattern | Type | Description
1098
+
---|:---:|---
1099
+
<a name="headerExtensions"></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.
1100
+
1061
1101
##### Header Object Example
1062
1102
1063
1103
A simple header with of an integer type:
@@ -1194,7 +1234,12 @@ Field Name | Type | Description
1194
1234
<a name="schemaXml"></a>xml | [XML Object](#xmlObject) | This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property.
1195
1235
<a name="schemaExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this schema.
1196
1236
<a name="schemaExample"></a>example | Any | A free-form property to include a an example of an instance for this schema.
1197
-
<a name="schemaExtensions"></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.
1237
+
1238
+
##### Patterned Objects
1239
+
1240
+
Field Pattern | Type | Description
1241
+
---|:---:|---
1242
+
<a name="schemaExtensions"></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.
1198
1243
1199
1244
###### Composition and Inheritance (Polymorphism)
1200
1245
@@ -1535,6 +1580,12 @@ Field Name | Type | Description
1535
1580
<a name="xmlAttribute"></a>attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`.
1536
1581
<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`).
1537
1582
1583
+
##### Patterned Objects
1584
+
1585
+
Field Pattern | Type | Description
1586
+
---|:---:|---
1587
+
<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.
1588
+
1538
1589
##### XML Object Examples
1539
1590
1540
1591
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.
@@ -1937,7 +1988,6 @@ This does *not* define global operation parameters.
1937
1988
Field Pattern | Type | Description
1938
1989
---|:---:|---
1939
1990
<a name="pdName"></a>{name} | [Parameter Object](#parameterObject) | A single parameter definition, mapping a "name" to the parameter it defines.
1940
-
<a name="parametersExtensions"></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.
1941
1991
1942
1992
##### Parameters Definition Object Example
1943
1993
@@ -2151,6 +2201,12 @@ Field Pattern | Type | Description
2151
2201
---|:---:|---
2152
2202
<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).
2153
2203
2204
+
##### Patterned Objects
2205
+
2206
+
Field Pattern | Type | Description
2207
+
---|:---:|---
2208
+
<a name="scopesExtensions"></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.
0 commit comments