Skip to content

Commit 2f613f7

Browse files
authored
Merge pull request OAI#950 from OAI/general-fixes
misc fixes
2 parents 7724607 + 8d54b86 commit 2f613f7

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

versions/3.0.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Additional utilities can also take advantage of the resulting files, such as tes
4848
- [Responses Object](#responsesObject)
4949
- [Response Object](#responseObject)
5050
- [Headers Object](#headersObject)
51-
- [Examples Object](#examplesObject)
51+
- [Example Object](#exampleObject)
5252
- [Links Object](#linksObject)
5353
- [Link Object](#linkObject)
5454
- [Link Parameters Object](#linkParametersObject)
@@ -397,7 +397,7 @@ All objects defined within the components object will have no effect on the API
397397

398398
##### Fixed Fields
399399

400-
Field Pattern | Type | Description
400+
Field Name | Type | Description
401401
---|:---|---
402402
<a name="componentsSchemas"></a> schemas | Map[`string`, [Schema Object](#schemaObject)] | An object to hold reusable [Schema Objects](#schemaObject).
403403
<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
11091109
<a name="requestBodyRequired"></a>required | `boolean` | Determines if the request body is required in the request. Defaults to `true`.
11101110

11111111

1112-
##### Patterned Fields
1113-
Field Pattern | Type | Description
1114-
---|:---:|---
1115-
<a name="requestBodyRepresentation"></a>`*` | [Schema Object](#schemaObject) <span>&#124;</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).
11181113

11191114
##### Request Body Examples
11201115

@@ -1560,16 +1555,6 @@ Field Name | Type | Description
15601555
<a name="responseContentObject"></a>content | [Content Object](#contentObject) | An object containing descriptions of potential response payloads.
15611556
<a name="responseLinks"></a>links | [Links Object](#linksObject) | An object representing operations related to the response payload.
15621557

1563-
1564-
##### Patterned Objects
1565-
1566-
Field Pattern | Type | Description
1567-
---|:---:|---
1568-
<a name="responseContentType"></a>`*` | [Schema Object](#schemaObject)<span>&#124;</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-
15731558
This object can be extended with [Specification Extensions](#specificationExtensions).
15741559

15751560
##### Response Object Examples
@@ -2381,7 +2366,7 @@ schemas:
23812366
$ref: http://foo.bar#/examples/name-example
23822367
23832368
# in a request body, note the plural `examples` as the Content-Type is set to `*`:
2384-
requestBody:
2369+
requestBody:
23852370
content:
23862371
'application/json':
23872372
schema:
@@ -2420,7 +2405,7 @@ schemas:
24202405
24212406
#### <a name="referenceObject"></a>Reference Object
24222407
2423-
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.
24242409
24252410
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.
24262411
@@ -2539,8 +2524,8 @@ To support polymorphism, OpenAPI Specification adds the support of the `discrimi
25392524
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.
25402525
As such, the `discriminator` field MUST be a required field.
25412526
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.
25442529
As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism.
25452530

25462531
###### XML Modeling
@@ -3458,7 +3443,7 @@ read:pets: read your pets
34583443
#### <a name="securityRequirementObject"></a>Security Requirement Object
34593444

34603445
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).
34623447

34633448
Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized.
34643449
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](
34693454

34703455
Field Pattern | Type | Description
34713456
---|:---:|---
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.
34733458

34743459
##### Security Requirement Object Examples
34753460

0 commit comments

Comments
 (0)