From 546ea6fc127416053fbc581338ba276d27e7a4ea Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Fri, 9 Aug 2024 16:53:08 +0200 Subject: [PATCH] Accepting suggestions from PR review --- versions/3.1.1.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/versions/3.1.1.md b/versions/3.1.1.md index 17d50c42f1..fc4b374e85 100644 --- a/versions/3.1.1.md +++ b/versions/3.1.1.md @@ -314,21 +314,21 @@ This is the root object of the [OpenAPI document](#openapi-description). | paths | [Paths Object](#paths-object) | The available paths and operations for the API. | | 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. | | components | [Components Object](#components-object) | An element to hold various schemas for the document. | -| security | [[Security Requirement Object](#security-requirement-object)] | See [the `security` field](#oas-security-field). +| 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). | 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. | | externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). -###### The `security` field +###### The `security` Field The `security` field describes how requests are authorized: - If omitted, then nothing can be inferred about the authorization requirements; the behaviour is implementation-defined. - If present but empty (`security: []`), then the behaviour is undefined. -- Otherwise, it is an array of Security Requirement Objects, only one of which needs to be satisfied for the request to be authorized. +- 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. -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"). +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"). Individual Operations can [override this field](#operation-security). @@ -979,7 +979,7 @@ Describes a single API operation on a path. | responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. | | 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. | | deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | -| 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. +| 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. | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions).