Skip to content

Commit 416fd3b

Browse files
author
Ron
authored
Merge pull request OAI#1052 from OAI/flow-to-flows
Flow to flows
2 parents 4d73304 + 560b0d3 commit 416fd3b

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

versions/3.0.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ my\org\User
508508
},
509509
"petstore_auth": {
510510
"type": "oauth2",
511-
"flow": {
511+
"flows": {
512512
"implicit": {
513513
"authorizationUrl": "http://example.org/api/oauth/dialog",
514514
"scopes": {
@@ -576,7 +576,7 @@ components:
576576
in: header
577577
petstore_auth:
578578
type: oauth2
579-
flow:
579+
flows:
580580
implicit:
581581
authorizationUrl: http://example.org/api/oauth/dialog
582582
scopes:
@@ -3362,7 +3362,7 @@ Field Name | Type | Validity | Description
33623362
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **Required.** The ___location of the API key. Valid values are `"query"` or `"header"`.
33633363
<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 RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2).
33643364
<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.
3365-
<a name="securitySchemeFlow"></a>flow | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **Required.** An object containing configuration information for the flow types supported.
3365+
<a name="securitySchemeFlows"></a>flows | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **Required.** An object containing configuration information for the flow types supported.
33663366
<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.
33673367

33683368
This object can be extended with [Specification Extensions](#specificationExtensions).
@@ -3420,7 +3420,7 @@ bearerFormat: JWT
34203420
```json
34213421
{
34223422
"type": "oauth2",
3423-
"flow": {
3423+
"flows": {
34243424
"implicit": {
34253425
"authorizationUrl": "https://example.com/api/oauth/dialog",
34263426
"scopes": {
@@ -3434,7 +3434,7 @@ bearerFormat: JWT
34343434

34353435
```yaml
34363436
type: oauth2
3437-
flow:
3437+
flows:
34383438
implicit:
34393439
authorizationUrl: https://example.com/api/oauth/dialog
34403440
scopes:
@@ -3449,10 +3449,10 @@ Allows configuration of the supported OAuth Flows.
34493449
##### Fixed Fields
34503450
Field Name | Type | Description
34513451
---|:---:|---
3452-
<a name="oauthFlowImplicit"></a>implicit| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Implicit flow
3453-
<a name="oauthFlowPassword"></a>password| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Resource Owner Password flow
3454-
<a name="oauthFlowClientCredentials"></a>clientCredentials| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0.
3455-
<a name="oauthFlowAuthorizationCode"></a>authorizationCode| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0.
3452+
<a name="oauthFlowsImplicit"></a>implicit| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Implicit flow
3453+
<a name="oauthFlowsPassword"></a>password| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Resource Owner Password flow
3454+
<a name="oauthFlowsClientCredentials"></a>clientCredentials| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0.
3455+
<a name="oauthFlowsAuthorizationCode"></a>authorizationCode| [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0.
34563456

34573457
This object can be extended with [Specification Extensions](#specificationExtensions).
34583458

@@ -3463,10 +3463,10 @@ Configuration details for a supported OAuth Flow
34633463
##### Fixed Fields
34643464
Field Name | Type | Validity | Description
34653465
---|:---:|---|---
3466-
<a name="securitySchemeAuthorizationUrl"></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.
3467-
<a name="securitySchemeTokenUrl"></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.
3468-
<a name="securitySchemeRefreshUrl"></a>refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
3469-
<a name="securitySchemeScopes"></a>scopes | [Scopes Object](#scopesObject) | `oauth2` | **Required.** The available scopes for the OAuth2 security scheme.
3466+
<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.
3467+
<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.
3468+
<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.
3469+
<a name="oauthFlowScopes"></a>scopes | [Scopes Object](#scopesObject) | `oauth2` | **Required.** The available scopes for the OAuth2 security scheme.
34703470

34713471
This object can be extended with [Specification Extensions](#specificationExtensions).
34723472

@@ -3475,7 +3475,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
34753475
```JSON
34763476
{
34773477
"type": "oauth2",
3478-
"flow": {
3478+
"flows": {
34793479
"implicit": {
34803480
"authorizationUrl": "https://example.com/api/oauth/dialog",
34813481
"scopes": {
@@ -3497,7 +3497,7 @@ This object can be extended with [Specification Extensions](#specificationExtens
34973497

34983498
```YAML
34993499
type: oauth2
3500-
flow:
3500+
flows:
35013501
implicit:
35023502
authorizationUrl: https://example.com/api/oauth/dialog
35033503
scopes:

0 commit comments

Comments
 (0)