Created
December 9, 2023 08:24
-
-
Save podhmo/b1320cbe38ae5504894f77647f7d7cbe to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- 3.0.2.md 2023-12-09 17:21:54 | |
| +++ 3.0.3.md 2023-12-09 17:21:54 | |
| @@ -1,6 +1,6 @@ | |
| # OpenAPI Specification | |
| -#### Version 3.0.2 | |
| +#### Version 3.0.3 | |
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here. | |
| @@ -71,8 +71,10 @@ | |
| A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification. | |
| ##### <a name="pathTemplating"></a>Path Templating | |
| -Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters. | |
| +Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters. | |
| +Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object). | |
| + | |
| ##### <a name="mediaTypes"></a>Media Types | |
| Media type definitions are spread across several resources. | |
| The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838). | |
| @@ -102,8 +104,10 @@ | |
| The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. | |
| -Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. | |
| +Each new minor version of the OpenAPI Specification SHALL allow any OpenAPI document that is valid against any previous minor version of the Specification, within the same major version, to be updated to the new Specification version with equivalent semantics. Such an update MUST only require changing the `openapi` property to the new minor version. | |
| +For example, a valid OpenAPI 3.0.2 document, upon changing its `openapi` property to `3.1.0`, SHALL be a valid OpenAPI 3.1.0 document, semantically equivalent to the original OpenAPI 3.0.2 document. New minor versions of the OpenAPI Specification MUST be written to ensure this form of backward compatibility. | |
| + | |
| An OpenAPI document compatible with OAS 3.\*.\* contains a required [`openapi`](#oasVersion) field which designates the semantic version of the OAS that it uses. (OAS 2.0 documents contain a top-level version field named [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerObject) and value `"2.0"`.) | |
| ### Format | |
| @@ -124,16 +128,16 @@ | |
| Patterned fields MUST have unique names within the containing object. | |
| -In order to preserve the ability to round-trip between YAML and JSON formats, YAML version [1.2](http://www.yaml.org/spec/1.2/spec.html) is RECOMMENDED along with some additional constraints: | |
| +In order to preserve the ability to round-trip between YAML and JSON formats, YAML version [1.2](https://yaml.org/spec/1.2/spec.html) is RECOMMENDED along with some additional constraints: | |
| -- Tags MUST be limited to those allowed by the [JSON Schema ruleset](http://www.yaml.org/spec/1.2/spec.html#id2803231). | |
| -- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](http://yaml.org/spec/1.2/spec.html#id2802346). | |
| +- Tags MUST be limited to those allowed by the [JSON Schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231). | |
| +- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346). | |
| **Note:** While APIs may be defined by OpenAPI documents in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML. | |
| ### <a name="documentStructure"></a>Document Structure | |
| -An OpenAPI document MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the user. In the latter case, `$ref` fields MUST be used in the specification to reference those parts as follows from the [JSON Schema](http://json-schema.org) definitions. | |
| +An OpenAPI document MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the user. In the latter case, `$ref` fields MUST be used in the specification to reference those parts as follows from the [JSON Schema](https://json-schema.org) definitions. | |
| It is RECOMMENDED that the root OpenAPI document be named: `openapi.json` or `openapi.yaml`. | |
| @@ -169,7 +173,7 @@ | |
| ### <a name="richText"></a>Rich Text Formatting | |
| Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. | |
| -Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](http://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. | |
| +Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](https://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. | |
| ### <a name="relativeReferences"></a>Relative References in URLs | |
| @@ -195,7 +199,7 @@ | |
| <a name="oasServers"></a>servers | [[Server Object](#serverObject)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#serverObject) with a [url](#serverUrl) value of `/`. | |
| <a name="oasPaths"></a>paths | [Paths Object](#pathsObject) | **REQUIRED**. The available paths and operations for the API. | |
| <a name="oasComponents"></a>components | [Components Object](#componentsObject) | An element to hold various schemas for the specification. | |
| -<a name="oasSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. | |
| +<a name="oasSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement (`{}`) can be included in the array. | |
| <a name="oasTags"></a>tags | [[Tag Object](#tagObject)] | A list of tags used by the specification 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](#operationObject) 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. | |
| <a name="oasExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation. | |
| @@ -210,8 +214,8 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="infoTitle"></a>title | `string` | **REQUIRED**. The title of the application. | |
| -<a name="infoDescription"></a>description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="infoTitle"></a>title | `string` | **REQUIRED**. The title of the API. | |
| +<a name="infoDescription"></a>description | `string` | A short description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | |
| <a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API. | |
| <a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API. | |
| @@ -320,7 +324,7 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| <a name="serverUrl"></a>url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | |
| -<a name="serverDescription"></a>description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="serverDescription"></a>description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="serverVariables"></a>variables | Map[`string`, [Server Variable Object](#serverVariableObject)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -429,9 +433,9 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="serverVariableEnum"></a>enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. | |
| -<a name="serverVariableDefault"></a>default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schemaObject) treatment of default values, because in those cases parameter values are optional. | |
| -<a name="serverVariableDescription"></a>description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="serverVariableEnum"></a>enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty. | |
| +<a name="serverVariableDefault"></a>default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schemaObject) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#serverVariableEnum) is defined, the value SHOULD exist in the enum's values. | |
| +<a name="serverVariableDescription"></a>description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -653,7 +657,7 @@ | |
| Field Pattern | Type | Description | |
| ---|:---:|--- | |
| -<a name="pathsPath"></a>/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#serverObject)'s `url` field in order to construct the full URL. [Path templating](#pathTemplating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | |
| +<a name="pathsPath"></a>/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#serverObject)'s `url` field in order to construct the full URL. [Path templating](#pathTemplating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -732,9 +736,9 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="pathItemRef"></a>$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#pathItemObject). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*. | |
| +<a name="pathItemRef"></a>$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#pathItemObject). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. | |
| <a name="pathItemSummary"></a>summary| `string` | An optional, string summary, intended to apply to all operations in this path. | |
| -<a name="pathItemDescription"></a>description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="pathItemDescription"></a>description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="pathItemGet"></a>get | [Operation Object](#operationObject) | A definition of a GET operation on this path. | |
| <a name="pathItemPut"></a>put | [Operation Object](#operationObject) | A definition of a PUT operation on this path. | |
| <a name="pathItemPost"></a>post | [Operation Object](#operationObject) | A definition of a POST operation on this path. | |
| @@ -828,9 +832,9 @@ | |
| required: true | |
| schema: | |
| type: array | |
| - style: simple | |
| items: | |
| type: string | |
| + style: simple | |
| ``` | |
| #### <a name="operationObject"></a>Operation Object | |
| @@ -843,15 +847,15 @@ | |
| ---|:---:|--- | |
| <a name="operationTags"></a>tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | |
| <a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. | |
| -<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation. | |
| <a name="operationId"></a>operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | |
| <a name="operationParameters"></a>parameters | [[Parameter Object](#parameterObject) \| [Reference Object](#referenceObject)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | |
| <a name="operationRequestBody"></a>requestBody | [Request Body Object](#requestBodyObject) \| [Reference Object](#referenceObject) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. | |
| <a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | |
| -<a name="operationCallbacks"></a>callbacks | Map[`string`, [Callback Object](#callbackObject) \| [Reference Object](#referenceObject)] | 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](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. | |
| +<a name="operationCallbacks"></a>callbacks | Map[`string`, [Callback Object](#callbackObject) \| [Reference Object](#referenceObject)] | 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](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses. | |
| <a name="operationDeprecated"></a>deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | |
| -<a name="operationSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | |
| +<a name="operationSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | |
| <a name="operationServers"></a>servers | [[Server Object](#serverObject)] | 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](#specificationExtensions). | |
| @@ -881,17 +885,17 @@ | |
| "application/x-www-form-urlencoded": { | |
| "schema": { | |
| "type": "object", | |
| - "properties": { | |
| - "name": { | |
| - "description": "Updated name of the pet", | |
| - "type": "string" | |
| - }, | |
| - "status": { | |
| - "description": "Updated status of the pet", | |
| - "type": "string" | |
| - } | |
| - }, | |
| - "required": ["status"] | |
| + "properties": { | |
| + "name": { | |
| + "description": "Updated name of the pet", | |
| + "type": "string" | |
| + }, | |
| + "status": { | |
| + "description": "Updated status of the pet", | |
| + "type": "string" | |
| + } | |
| + }, | |
| + "required": ["status"] | |
| } | |
| } | |
| } | |
| @@ -974,7 +978,7 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="externalDocDescription"></a>description | `string` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="externalDocUrl"></a>url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -1010,10 +1014,10 @@ | |
| ##### Fixed Fields | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="parameterName"></a>name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*. <ul><li>If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#pathsObject). See [Path Templating](#pathTemplating) for further information.<li>If [`in`](#parameterIn) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.<li>For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameterIn) property.</ul> | |
| -<a name="parameterIn"></a>in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". | |
| -<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| -<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | |
| +<a name="parameterName"></a>name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*. <ul><li>If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#pathsPath) field in the [Paths Object](#pathsObject). See [Path Templating](#pathTemplating) for further information.<li>If [`in`](#parameterIn) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.<li>For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameterIn) property.</ul> | |
| +<a name="parameterIn"></a>in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | |
| +<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | |
| <a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | |
| <a name="parameterAllowEmptyValue"></a> allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. | |
| @@ -1023,11 +1027,11 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| <a name="parameterStyle"></a>style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | |
| -<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | |
| +<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | |
| <a name="parameterAllowReserved"></a>allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | |
| <a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | The schema defining the type used for the parameter. | |
| -<a name="parameterExample"></a>example | Any | Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | |
| -<a name="parameterExamples"></a>examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | |
| +<a name="parameterExample"></a>example | Any | Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | |
| +<a name="parameterExamples"></a>examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema. | |
| For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. | |
| A parameter MUST contain either a `schema` property, or a `content` property, but not both. | |
| @@ -1036,7 +1040,7 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="parameterContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry. | |
| +<a name="parameterContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry. | |
| ##### Style Values | |
| @@ -1065,7 +1069,7 @@ | |
| The following table shows examples of rendering differences for each value. | |
| [`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` | |
| ------------ | ------ | -------- | -------- | --------|------- | |
| +----------- | ------ | -------- | -------- | -------- | ------- | |
| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | |
| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | |
| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | |
| @@ -1075,7 +1079,7 @@ | |
| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | |
| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | |
| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | |
| -pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200|G\|150 | |
| +pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200\|B\|150 | |
| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -1244,7 +1248,7 @@ | |
| ##### Fixed Fields | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="requestBodyDescription"></a>description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="requestBodyDescription"></a>description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="requestBodyContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* | |
| <a name="requestBodyRequired"></a>required | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | |
| @@ -1460,7 +1464,6 @@ | |
| requestBody: | |
| content: | |
| application/octet-stream: | |
| - # any media type is accepted, functionally equivalent to `*/*` | |
| schema: | |
| # a binary file of any type | |
| type: string | |
| @@ -1704,7 +1707,7 @@ | |
| ##### Fixed Fields | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="responseDescription"></a>description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="responseDescription"></a>description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="responseHeaders"></a>headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | |
| <a name="responseContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* | |
| <a name="responseLinks"></a>links | Map[`string`, [Link Object](#linkObject) \| [Reference Object](#referenceObject)] | A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject). | |
| @@ -1773,7 +1776,8 @@ | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| - "type": "string" | |
| + "type": "string", | |
| + "example": "whoa!" | |
| } | |
| } | |
| }, | |
| @@ -1838,7 +1842,7 @@ | |
| A map of possible out-of band callbacks related to the parent operation. | |
| Each value in the map is a [Path Item Object](#pathItemObject) that describes a set of requests that may be initiated by the API provider and the expected responses. | |
| -The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. | |
| +The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. | |
| ##### Patterned Fields | |
| Field Pattern | Type | Description | |
| @@ -1889,13 +1893,13 @@ | |
| $response.header.Location | http://example.org/subscription/1 | |
| -##### Callback Object Example | |
| +##### Callback Object Examples | |
| -The following example shows a callback to the URL specified by the `id` and `email` property in the request body. | |
| +The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook. | |
| ```yaml | |
| -myWebhook: | |
| - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': | |
| +myCallback: | |
| + '{$request.query.queryUrl}': | |
| post: | |
| requestBody: | |
| description: Callback payload | |
| @@ -1905,9 +1909,25 @@ | |
| $ref: '#/components/schemas/SomePayload' | |
| responses: | |
| '200': | |
| - description: webhook successfully processed and no retries will be performed | |
| + description: callback successfully processed | |
| ``` | |
| +The following example shows a callback where the server is hard-coded, but the query string parameters are populated from the `id` and `email` property in the request body. | |
| + | |
| +```yaml | |
| +transactionCallback: | |
| + 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': | |
| + post: | |
| + requestBody: | |
| + description: Callback payload | |
| + content: | |
| + 'application/json': | |
| + schema: | |
| + $ref: '#/components/schemas/SomePayload' | |
| + responses: | |
| + '200': | |
| + description: callback successfully processed | |
| +``` | |
| #### <a name="exampleObject"></a>Example Object | |
| @@ -1915,7 +1935,7 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| <a name="exampleSummary"></a>summary | `string` | Short description for the example. | |
| -<a name="exampleDescription"></a>description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="exampleDescription"></a>description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="exampleValue"></a>value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | |
| <a name="exampleExternalValue"></a>externalValue | `string` | A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The `value` field and `externalValue` field are mutually exclusive. | |
| @@ -1927,18 +1947,6 @@ | |
| ##### Example Object Examples | |
| -In a model: | |
| - | |
| -```yaml | |
| -schemas: | |
| - properties: | |
| - name: | |
| - type: string | |
| - examples: | |
| - name: | |
| - $ref: http://example.org/petapi-examples/openapi.json#/components/examples/name-example | |
| -``` | |
| - | |
| In a request body: | |
| ```yaml | |
| @@ -1975,9 +1983,9 @@ | |
| schema: | |
| type: 'string' | |
| format: 'zip-code' | |
| - examples: | |
| - zip-example: | |
| - $ref: '#/components/examples/zip-example' | |
| + examples: | |
| + zip-example: | |
| + $ref: '#/components/examples/zip-example' | |
| ``` | |
| In a response: | |
| @@ -2009,11 +2017,11 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="linkOperationRef"></a>operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operationObject). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operationObject) in the OpenAPI definition. | |
| +<a name="linkOperationRef"></a>operationRef | `string` | A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operationObject). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operationObject) in the OpenAPI definition. | |
| <a name="linkOperationId"></a>operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | |
| <a name="linkParameters"></a>parameters | Map[`string`, Any \| [{expression}](#runtimeExpression)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | |
| <a name="linkRequestBody"></a>requestBody | Any \| [{expression}](#runtimeExpression) | A literal value or [{expression}](#runtimeExpression) to use as a request body when calling the target operation. | |
| -<a name="linkDescription"></a>description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="linkDescription"></a>description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="linkServer"></a>server | [Server Object](#serverObject) | A server object to be used by the target operation. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -2094,7 +2102,7 @@ | |
| ##### OperationRef Examples | |
| As references to `operationId` MAY NOT be possible (the `operationId` is an optional | |
| -value), references MAY also be made through a relative `operationRef`: | |
| +field in an [Operation Object](#operationObject)), references MAY also be made through a relative `operationRef`: | |
| ```yaml | |
| links: | |
| @@ -2127,19 +2135,27 @@ | |
| The runtime expression is defined by the following [ABNF](https://tools.ietf.org/html/rfc5234) syntax | |
| -``` | |
| - expression = ( "$url" | "$method" | "$statusCode" | "$request." source | "$response." source ) | |
| - source = ( header-reference | query-reference | path-reference | body-reference ) | |
| +```abnf | |
| + expression = ( "$url" / "$method" / "$statusCode" / "$request." source / "$response." source ) | |
| + source = ( header-reference / query-reference / path-reference / body-reference ) | |
| header-reference = "header." token | |
| query-reference = "query." name | |
| path-reference = "path." name | |
| - body-reference = "body" ["#" fragment] | |
| - fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) | |
| - name = *( char ) | |
| - char = as per RFC [7159](https://tools.ietf.org/html/rfc7159#section-7) | |
| - token = as per RFC [7230](https://tools.ietf.org/html/rfc7230#section-3.2.6) | |
| + body-reference = "body" ["#" json-pointer ] | |
| + json-pointer = *( "/" reference-token ) | |
| + reference-token = *( unescaped / escaped ) | |
| + unescaped = %x00-2E / %x30-7D / %x7F-10FFFF | |
| + ; %x2F ('/') and %x7E ('~') are excluded from 'unescaped' | |
| + escaped = "~" ( "0" / "1" ) | |
| + ; representing '~' and '/', respectively | |
| + name = *( CHAR ) | |
| + token = 1*tchar | |
| + tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." / | |
| + "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA | |
| ``` | |
| +Here, `json-pointer` is taken from [RFC 6901](https://tools.ietf.org/html/rfc6901), `char` from [RFC 7159](https://tools.ietf.org/html/rfc7159#section-7) and `token` from [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2.6). | |
| + | |
| The `name` identifier is case-sensitive, whereas `token` is not. | |
| The table below provides examples of runtime expressions and examples of their use in a value: | |
| @@ -2195,7 +2211,7 @@ | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| <a name="tagName"></a>name | `string` | **REQUIRED**. The name of the tag. | |
| -<a name="tagDescription"></a>description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="tagDescription"></a>description | `string` | A short description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="tagExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this tag. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -2268,7 +2284,7 @@ | |
| The Schema Object allows the definition of input and output data types. | |
| These types can be objects, but also primitives and arrays. | |
| -This object is an extended subset of the [JSON Schema Specification Wright Draft 00](http://json-schema.org/). | |
| +This object is an extended subset of the [JSON Schema Specification Wright Draft 00](https://json-schema.org/). | |
| For more information about the properties, see [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00) and [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00). | |
| Unless stated otherwise, the property definitions follow the JSON Schema. | |
| @@ -2285,7 +2301,7 @@ | |
| - exclusiveMinimum | |
| - maxLength | |
| - minLength | |
| -- pattern (This string SHOULD be a valid regular expression, according to the [ECMA 262 regular expression](https://www.ecma-international.org/ecma-262/5.1/#sec-7.8.5) dialect) | |
| +- pattern (This string SHOULD be a valid regular expression, according to the [Ecma-262 Edition 5.1 regular expression](https://www.ecma-international.org/ecma-262/5.1/#sec-15.10.1) dialect) | |
| - maxItems | |
| - minItems | |
| - uniqueItems | |
| @@ -2303,7 +2319,7 @@ | |
| - items - Value MUST be an object and not an array. Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. `items` MUST be present if the `type` is `array`. | |
| - properties - Property definitions MUST be a [Schema Object](#schemaObject) and not a standard JSON Schema (inline or referenced). | |
| - additionalProperties - Value can be boolean or object. Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. Consistent with JSON Schema, `additionalProperties` defaults to `true`. | |
| -- description - [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +- description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| - format - See [Data Type Formats](#dataTypeFormat) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. | |
| - default - The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if `type` is `string`, then `default` can be `"foo"` but cannot be `1`. | |
| @@ -2316,7 +2332,7 @@ | |
| ##### Fixed Fields | |
| Field Name | Type | Description | |
| ---|:---:|--- | |
| -<a name="schemaNullable"></a>nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. | |
| +<a name="schemaNullable"></a>nullable | `boolean` | A `true` value adds `"null"` to the allowed type specified by the `type` keyword, only if `type` is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of `null` as a value. A `false` value leaves the specified or default `type` unmodified. The default value is `false`. | |
| <a name="schemaDiscriminator"></a>discriminator | [Discriminator Object](#discriminatorObject) | Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See [Composition and Inheritance](#schemaComposition) for more details. | |
| <a name="schemaReadOnly"></a>readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as `readOnly` being `true` and is in the `required` list, the `required` will take effect on the response only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. | |
| <a name="schemaWriteOnly"></a>writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as `writeOnly` being `true` and is in the `required` list, the `required` will take effect on the request only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. | |
| @@ -3163,16 +3179,16 @@ | |
| #### <a name="securitySchemeObject"></a>Security Scheme Object | |
| Defines a security scheme that can be used by the operations. | |
| -Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). | |
| +Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). | |
| ##### Fixed Fields | |
| Field Name | Type | Applies To | Description | |
| ---|:---:|---|--- | |
| <a name="securitySchemeType"></a>type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | |
| -<a name="securitySchemeDescription"></a>description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | |
| +<a name="securitySchemeDescription"></a>description | `string` | Any | A short description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | |
| <a name="securitySchemeName"></a>name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | |
| <a name="securitySchemeIn"></a>in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | |
| -<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). | |
| +<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). | |
| <a name="securitySchemeBearerFormat"></a>bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. | |
| <a name="securitySchemeFlows"></a>flows | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | |
| <a name="securitySchemeOpenIdConnectUrl"></a>openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. | |
| @@ -3278,7 +3294,7 @@ | |
| <a name="oauthFlowAuthorizationUrl"></a>authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. | |
| <a name="oauthFlowTokenUrl"></a>tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. | |
| <a name="oauthFlowRefreshUrl"></a>refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. | |
| -<a name="oauthFlowScopes"></a>scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. | |
| +<a name="oauthFlowScopes"></a>scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | |
| This object MAY be extended with [Specification Extensions](#specificationExtensions). | |
| @@ -3323,7 +3339,6 @@ | |
| read:pets: read your pets | |
| ``` | |
| - | |
| #### <a name="securityRequirementObject"></a>Security Requirement Object | |
| Lists the required security schemes to execute this operation. | |
| @@ -3338,7 +3353,7 @@ | |
| Field Pattern | Type | Description | |
| ---|:---:|--- | |
| -<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. | |
| +<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, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MUST be empty. | |
| ##### Security Requirement Object Examples | |
| @@ -3369,8 +3384,34 @@ | |
| petstore_auth: | |
| - write:pets | |
| - read:pets | |
| +``` | |
| + | |
| +###### Optional OAuth2 Security | |
| + | |
| +Optional OAuth2 security as would be defined in an <a href="#openapi-object">OpenAPI Object</a> or an <a href="#operation-object">Operation Object</a>: | |
| + | |
| +```json | |
| +{ | |
| + "security": [ | |
| + {}, | |
| + { | |
| + "petstore_auth": [ | |
| + "write:pets", | |
| + "read:pets" | |
| + ] | |
| + } | |
| + ] | |
| +} | |
| ``` | |
| +```yaml | |
| +security: | |
| + - {} | |
| + - petstore_auth: | |
| + - write:pets | |
| + - read:pets | |
| +``` | |
| + | |
| ### <a name="specificationExtensions"></a>Specification Extensions | |
| While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points. | |
| @@ -3393,19 +3434,20 @@ | |
| Two examples of this: | |
| 1. The [Paths Object](#pathsObject) MAY be empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can't access any documentation. They'd still have access to the [Info Object](#infoObject) which may contain additional information regarding authentication. | |
| -2. The [Path Item Object](#pathItemObject) MAY be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different than hiding the path itself from the [Paths Object](#pathsObject), so the user will not be aware of its existence. This allows the documentation provider to finely control what the viewer can see. | |
| +2. The [Path Item Object](#pathItemObject) MAY be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different from hiding the path itself from the [Paths Object](#pathsObject), because the user will be aware of its existence. This allows the documentation provider to finely control what the viewer can see. | |
| ## <a name="revisionHistory"></a>Appendix A: Revision History | |
| Version | Date | Notes | |
| --- | --- | --- | |
| +3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | |
| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | |
| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | |
| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | |
| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | |
| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | |
| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | |
| -2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative | |
| +2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | |
| 2.0 | 2014-09-08 | Release of Swagger 2.0 | |
| 1.2 | 2014-03-14 | Initial release of the formal document. | |
| 1.1 | 2012-08-22 | Release of Swagger 1.1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment