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
+15-10Lines changed: 15 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -181,7 +181,7 @@ It combines what previously was the Resource Listing and API Declaration (versio
181
181
182
182
Field Name | Type | Description
183
183
---|:---:|---
184
-
<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.
184
+
<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.
185
185
<aname="oasInfo"></a>info | [Info Object](#infoObject) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed.
186
186
<aname="oasServers"></a>servers | [[Server Object](#serverObject)] | An optional array of Server Objects which provide connectivity information to a target server.
187
187
<aname="oasPaths"></a>paths | [Paths Object](#pathsObject) | **Required.** The available paths and operations for the API.
@@ -192,7 +192,7 @@ Field Name | Type | Description
192
192
193
193
This object can be extended with [Specification Extensions](#specificationExtensions).
194
194
195
-
#### <aname="oasVersion"></a>OpenAPI Version String
195
+
#### <aname="oasVersionString"></a>OpenAPI Version String
196
196
197
197
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.
198
198
@@ -384,7 +384,7 @@ An object representing a Server Variable for server URL template substituion.
384
384
385
385
Field Name | Type | Description
386
386
---|:---:|---
387
-
<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
+
<a name="serverVariableEnum"></a>enum | [`primitive`] | An enumeration of primitive type values to be used if the substitution options are from a limited set.
388
388
<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.
389
389
<a name="serverVariableDescription"></a>description | `string` | An optional description for the server variable.
390
390
@@ -410,6 +410,8 @@ Field Pattern | Type | Description
410
410
<a name="componentsLinks"></a> links | Map[`string`, [Link Object](#linkObject)] | An object to hold reusable [Link Objects](#linkObject).
411
411
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Objects](#callbackObject).
412
412
413
+
This object can be extended with [Specification Extensions](#specificationExtensions).
414
+
413
415
All the fixed fields declared above are objects that MUST use keys that match the regular expression: `[a-zA-Z0-9.\-_]+`.
414
416
415
417
Field Name Examples:
@@ -1076,20 +1078,23 @@ A free-form query parameter, allowing undefined parameters of a specific type:
0 commit comments