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/3.0.md
+16-15Lines changed: 16 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -180,7 +180,7 @@ It combines what previously was the Resource Listing and API Declaration (versio
180
180
181
181
Field Name | Type | Description
182
182
---|:---:|---
183
-
<aname="oasVersion"></a>openapi | [OpenAPI Version String](#oasVersion) | **Required.** Specifies the OpenAPI Specification version being used. It can be used by tooling Specifications and clients to interpret the version. The structure SHALL be `major`.`minor`.`patch`, where `patch` versions MUST be compatible with the existing `major`.`minor` tooling. Typically patch versions will be introduced to address errors in the documentation, and tooling SHOULD typically be compatible with the corresponding `major`.`minor` (3.0.*). Patch versions will correspond to patches of this document.
183
+
<aname="oasVersion"></a>openapi | `string` | **Required.** Specifies the OpenAPI Specification version being used. It can be used by tooling Specifications and clients to interpret the version. The structure SHALL be `major`.`minor`.`patch`, where `patch` versions MUST be compatible with the existing `major`.`minor` tooling. Typically patch versions will be introduced to address errors in the documentation, and tooling SHOULD typically be compatible with the corresponding `major`.`minor` (3.0.*). Patch versions will correspond to patches of this document.
184
184
<aname="oasInfo"></a>info | [Info Object](#infoObject) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed.
185
185
<aname="oasServers"></a>servers | [[Server Object](#serverObject)] | An optional array of Server Objects which provide connectivity information to a target server.
186
186
<aname="oasPaths"></a>paths | [Paths Object](#pathsObject) | **Required.** The available paths and operations for the API.
@@ -191,7 +191,7 @@ Field Name | Type | Description
191
191
192
192
This object can be extended with [Specification Extensions](#specificationExtensions).
193
193
194
-
#### <aname="oasVersion"></a>OpenAPI Version String
194
+
#### <aname="oasVersionString"></a>OpenAPI Version String
195
195
196
196
The version string signifies the version of the OpenAPI Specification that the document complies to. The format for this string MUST be `major`.`minor`.`patch`. The `patch` MAY be suffixed by a hyphen and extra alphanumeric characters.
197
197
@@ -383,7 +383,7 @@ An object representing a Server Variable for server URL template substituion.
383
383
384
384
Field Name | Type | Description
385
385
---|:---:|---
386
-
<a name="serverVariableEnum"></a>enum | [`primitive`] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
386
+
<a name="serverVariableEnum"></a>enum | [`primitive`] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
387
387
<a name="serverVariableDefault"></a>default | `primitive` | **Required.** The default value to use for substitution if an alternate value is not specified, and will be sent if an alternative value is _not_ supplied. Unlike the [Schema Object's](#schemaObject) `default`, this value MUST be provided by the consumer.
388
388
<a name="serverVariableDescription"></a>description | `string` | An optional description for the server variable.
389
389
@@ -409,6 +409,8 @@ Field Pattern | Type | Description
409
409
<a name="componentsLinks"></a> links | Map[`string`, [Link Object](#linkObject)] | An object to hold reusable [Link Objects](#linkObject).
410
410
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Objects](#callbackObject).
411
411
412
+
This object can be extended with [Specification Extensions](#specificationExtensions).
413
+
412
414
All the fixed fields declared above are objects that MUST use keys that match the regular expression: `[a-zA-Z0-9.\-_]+`.
413
415
414
416
Field Name Examples:
@@ -1075,20 +1077,23 @@ A free-form query parameter, allowing undefined parameters of a specific type:
1075
1077
{
1076
1078
"in": "query",
1077
1079
"name": "freeForm",
1078
-
"type": "object",
1079
-
"additionalProperties": {
1080
-
"type": "integer"
1081
-
},
1080
+
"schema": {
1081
+
"type": "object",
1082
+
"additionalProperties": {
1083
+
"type": "integer"
1084
+
},
1085
+
}
1082
1086
"style": "form"
1083
1087
}
1084
1088
```
1085
1089
1086
1090
```yaml
1087
1091
in: query
1088
1092
name: freeForm
1089
-
type: object
1090
-
additionalProperties:
1091
-
type: integer
1093
+
schema:
1094
+
type: object
1095
+
additionalProperties:
1096
+
type: integer
1092
1097
style: form
1093
1098
```
1094
1099
@@ -1258,16 +1263,12 @@ Each Media Type Object provides schema and examples for a the media type identif
1258
1263
##### Fixed Fields
1259
1264
Field Name | Type | Description
1260
1265
---|:---:|---
1261
-
1262
1266
<a name="mediaTypeSchema"></a>schema | [Schema Object](#schemaObject) <span>|</span> [Reference Object](#referenceObject)] | The schema defining the type used for the request body.
1263
1267
<a name="mediaTypeExamples"></a>examples | [[Example Object](#exampleObject) <span>|</span> [Reference Object](#referenceObject)] | Examples of the media type. Each example in the Examples array SHOULD be in the correct format as specified in the media type. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema.
1264
1268
<a name="mediaTypeExample"></a>example | [Example Object](#exampleObject) <span>|</span> [Reference Object](#referenceObject) | Example of the media type. The example object SHOULD be in the correct format as specified in the media type. The `example` object is mutually exclusive to the `examples` object. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the the example provided by the schema.
1265
1269
<a name="mediaTypeEncoding"></a>encoding | [Encoding Object](#encodingObject) | Encoding of the media type. The encoding object SHOULD only apply to `requestBody` objects when the content type is `multipart`.
1266
1270
1267
-
##### Patterned Fields
1268
-
Field Pattern | Type | Description
1269
-
---|:---:|---
1270
-
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI 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 [Specification Extensions](#specificationExtensions) for further details.
1271
+
This object can be extended with [Specification Extensions](#specificationExtensions).
0 commit comments