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
+9-24Lines changed: 9 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ Additional utilities can also take advantage of the resulting files, such as tes
48
48
- [Responses Object](#responsesObject)
49
49
- [Response Object](#responseObject)
50
50
- [Headers Object](#headersObject)
51
-
- [Examples Object](#examplesObject)
51
+
- [Example Object](#exampleObject)
52
52
- [Links Object](#linksObject)
53
53
- [Link Object](#linkObject)
54
54
- [Link Parameters Object](#linkParametersObject)
@@ -397,7 +397,7 @@ All objects defined within the components object will have no effect on the API
397
397
398
398
##### Fixed Fields
399
399
400
-
Field Pattern | Type | Description
400
+
Field Name | Type | Description
401
401
---|:---|---
402
402
<a name="componentsSchemas"></a> schemas | Map[`string`, [Schema Object](#schemaObject)] | An object to hold reusable [Schema Objects](#schemaObject).
403
403
<a name="componentsResponses"></a> responses | Map[`string`, [Response Object](#responseObject)] | An object to hold reusable [Response Objects](#responseObject).
@@ -1109,12 +1109,7 @@ Field Name | Type | Description
1109
1109
<a name="requestBodyRequired"></a>required | `boolean` | Determines if the request body is required in the request. Defaults to `true`.
1110
1110
1111
1111
1112
-
##### Patterned Fields
1113
-
Field Pattern | Type | Description
1114
-
---|:---:|---
1115
-
<a name="requestBodyRepresentation"></a>`*` | [Schema Object](#schemaObject) <span>|</span> [Reference Object](#referenceObject)] | The schema defining the request body.
1116
-
<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.
1117
-
1112
+
This object can be extended with [Specification Extensions](#specificationExtensions).
1118
1113
1119
1114
##### Request Body Examples
1120
1115
@@ -1560,16 +1555,6 @@ Field Name | Type | Description
1560
1555
<a name="responseContentObject"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
1561
1556
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
1562
1557
1563
-
1564
-
##### Patterned Objects
1565
-
1566
-
Field Pattern | Type | Description
1567
-
---|:---:|---
1568
-
<a name="responseContentType"></a>`*` | [Schema Object](#schemaObject)<span>|</span> [Reference Object](#referenceObject) | A schema describing the response value for a specific `Content-Type`
1569
-
1570
-
Representations MAY take the form of a wildcard (`*`) to designate any `Content-Type`,
1571
-
or a regular expression for matching a specific type
1572
-
1573
1558
This object can be extended with [Specification Extensions](#specificationExtensions).
1574
1559
1575
1560
##### Response Object Examples
@@ -2381,7 +2366,7 @@ schemas:
2381
2366
$ref: http://foo.bar#/examples/name-example
2382
2367
2383
2368
# in a request body, note the plural `examples` as the Content-Type is set to `*`:
A simple object to allow referencing other definitions in the specification, internally and externally.
2408
+
A simple object to allow referencing other components in the specification, internally and externally.
2424
2409
2425
2410
The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) and follows the same structure, behavior and rules.
2426
2411
@@ -2539,8 +2524,8 @@ To support polymorphism, OpenAPI Specification adds the support of the `discrimi
2539
2524
When used, the `discriminator` will be the name of the property used to decide which schema definition is used to validate the structure of the model.
2540
2525
As such, the `discriminator` field MUST be a required field.
2541
2526
There are are two ways to define the value of a discriminator for an inheriting instance.
2542
-
- Use the definition's name.
2543
-
- Override the definition's name by overriding the property with a new value. If exists, this takes precedence over the definition's name.
2527
+
- Use the schema's name.
2528
+
- Override the schema's name by overriding the property with a new value. If exists, this takes precedence over the schema's name.
2544
2529
As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism.
Lists the required security schemes to execute this operation.
3461
-
The name used for each property MUST correspond to a security scheme declared in the [Security Definitions](#componentsSecuritySchemes) under the [Components Object](#componentsObject).
3446
+
The name used for each property MUST correspond to a security scheme declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#componentsObject).
3462
3447
3463
3448
Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized.
3464
3449
This enables support for scenarios where there multiple query parameters or HTTP headers are required to convey security information.
@@ -3469,7 +3454,7 @@ When a list of Security Requirement Objects is defined on the [Open API object](
3469
3454
3470
3455
Field Pattern | Type | Description
3471
3456
---|:---:|---
3472
-
<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"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.
3457
+
<a name="securityRequirementsName"></a>{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#componentsObject). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, 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