Skip to content

Commit 546ea6f

Browse files
ralfhandlrvedotrc
ralfhandl
authored and
rvedotrc
committed
Accepting suggestions from PR review
1 parent 8c8b876 commit 546ea6f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

‎versions/3.1.1.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -314,21 +314,21 @@ This is the root object of the [OpenAPI document](#openapi-description).
314314
| <a name="oas-paths"></a>paths | [Paths Object](#paths-object) | The available paths and operations for the API. |
315315
| <a name="oas-webhooks"></a>webhooks | Map[`string`, [Path Item Object](#path-item-object)] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](../examples/v3.1/webhook-example.yaml) is available. |
316316
| <a name="oas-components"></a>components | [Components Object](#components-object) | An element to hold various schemas for the document. |
317-
| <a name="oas-security"></a>security | [[Security Requirement Object](#security-requirement-object)] | See [the `security` field](#oas-security-field).
317+
| <a name="oas-security"></a>security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used across the API. See [The `security` Field](#the-security-field).
318318
| <a name="oas-tags"></a>tags | [[Tag Object](#tag-object)] | A list of tags used by the document 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](#operation-object) 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. |
319319
| <a name="oas-external-docs"></a>externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. |
320320

321321
This object MAY be extended with [Specification Extensions](#specification-extensions).
322322

323-
###### <a name="oas-security-field"></a>The `security` field
323+
###### The `security` Field
324324

325325
The `security` field describes how requests are authorized:
326326

327327
- If omitted, then nothing can be inferred about the authorization requirements; the behaviour is implementation-defined.
328328
- If present but empty (`security: []`), then the behaviour is undefined.
329-
- Otherwise, it is an array of Security Requirement Objects, only one of which needs to be satisfied for the request to be authorized.
329+
- Otherwise, it is an array of [Security Requirement Objects](#security-requirement-object), only one of which needs to be satisfied for the request to be authorized.
330330

331-
Because the empty [Security Requirement Object](#security-requirement-object) `{}` will always be satisfied, any `security` list that includes `{}` will allow all requests. In particular, `security: [{}]` means that no security schemes are in use (also known as "no security").
331+
Because the empty Security Requirement Object `{}` will always be satisfied, any `security` list that includes `{}` will allow all requests. In particular, `security: [{}]` means that no security schemes are in use (also known as "no security").
332332

333333
Individual Operations can [override this field](#operation-security).
334334

@@ -979,7 +979,7 @@ Describes a single API operation on a path.
979979
| <a name="operation-responses"></a>responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. |
980980
| <a name="operation-callbacks"></a>callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. |
981981
| <a name="operation-deprecated"></a>deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. |
982-
| <a name="operation-security"></a>security | [[Security Requirement Object](#security-requirement-object)] | If present, then this overrides any [top-level `security` field](#oas-security) for this operation. See the definition of that field for details.
982+
| <a name="operation-security"></a>security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. If present, then this overrides any [top-level `security` field](#oas-security) for this operation. See the [definition of that field](#the-security-field) for details.
983983
| <a name="operation-servers"></a>servers | [[Server Object](#server-object)] | An alternative `server` array to service this operation. If an alternative `server` object is specified at the Path Item Object or Root level, it will be overridden by this value. |
984984

985985
This object MAY be extended with [Specification Extensions](#specification-extensions).

0 commit comments

Comments
 (0)