Skip to content

Commit 0e18944

Browse files
committed
Removed the provision for default scope represented as empty string. This introduces some ambiguities in the Security Requirement Object that would need to be addressed.
1 parent 79470fe commit 0e18944

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

versions/3.0.3.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3286,13 +3286,13 @@ Field Name | Type | Applies To | Description
32863286
<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.
32873287
<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.
32883288
<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.
3289-
<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. If scope is optional, the map MAY include an entry with an empty string as its key to represent the default scope. If scope is not used in the authorization scheme, the map MAY be empty.
3289+
<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. If scope is not required or not specified in the authorization scheme, the map MAY be empty.
32903290

32913291
This object MAY be extended with [Specification Extensions](#specificationExtensions).
32923292

32933293
##### OAuth Flow Object Examples
32943294

3295-
###### OAuth Flows with Required Scope
3295+
###### OAuth Flows with Defined Scopes
32963296

32973297
```JSON
32983298
{
@@ -3333,7 +3333,7 @@ flows:
33333333
read:pets: read your pets
33343334
```
33353335

3336-
###### OAuth Flows with Unspecified and Optional Scope
3336+
###### OAuth Flows with Optional or Unspecified Scope
33373337

33383338
```JSON
33393339
{
@@ -3346,10 +3346,7 @@ flows:
33463346
"authorizationCode": {
33473347
"authorizationUrl": "https://example.com/api/oauth/dialog",
33483348
"tokenUrl": "https://example.com/api/oauth/token",
3349-
"scopes": {
3350-
"write:pets": "modify pets in your account",
3351-
"": "default scope provides read-only access"
3352-
}
3349+
"scopes": {}
33533350
}
33543351
}
33553352
}
@@ -3364,9 +3361,7 @@ flows:
33643361
authorizationCode:
33653362
authorizationUrl: https://example.com/api/oauth/dialog
33663363
tokenUrl: https://example.com/api/oauth/token
3367-
scopes:
3368-
write:pets: modify pets in your account
3369-
"" : default scope provides read-only access
3364+
scopes: {}
33703365
```
33713366

33723367
#### <a name="securityRequirementObject"></a>Security Requirement Object

0 commit comments

Comments
 (0)