Skip to content

Commit afaf499

Browse files
bbiggerrbbiggerr
authored
Merge pull request #632 from bbiggerr/dbaas-scopes
[Update] Add Databases scopes
2 parents da11489 + a49a917 commit afaf499

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

‎openapi.yaml‎

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ info:
143143
|-----------------------|--------|
144144
| **Authorization URL** | https://login.linode.com/oauth/authorize |
145145
| **Token URL** | https://login.linode.com/oauth/token |
146-
| **Scopes** | <ul><li>`account:read_only` - Allows access to GET information about your Account.</li><li>`account:read_write` - Allows access to all endpoints related to your Account.</li><li>`domains:read_only` - Allows access to GET Domains on your Account.</li><li>`domains:read_write` - Allows access to all Domain endpoints.</li><li>`events:read_only` - Allows access to GET your Events.</li><li>`events:read_write` - Allows access to all endpoints related to your Events.</li><li>`firewall:read_only` - Allows access to GET information about your Firewalls.</li><li>`firewall:read_write` - Allows access to all Firewall endpoints.</li><li>`images:read_only` - Allows access to GET your Images.</li><li>`images:read_write` - Allows access to all endpoints related to your Images.</li><li>`ips:read_only` - Allows access to GET your ips.</li><li>`ips:read_write` - Allows access to all endpoints related to your ips.</li><li>`linodes:read_only` - Allows access to GET Linodes on your Account.</li><li>`linodes:read_write` - Allow access to all endpoints related to your Linodes.</li><li>`lke:read_only` - Allows access to GET LKE Clusters on your Account.</li><li>`lke:read_write` - Allows access to all endpoints related to LKE Clusters on your Account.</li><li>`longview:read_only` - Allows access to GET your Longview Clients.</li><li>`longview:read_write` - Allows access to all endpoints related to your Longview Clients.</li><li>`maintenance:read_only` - Allows access to GET information about Maintenance on your account.</li><li>`nodebalancers:read_only` - Allows access to GET NodeBalancers on your Account.</li><li>`nodebalancers:read_write` - Allows access to all NodeBalancer endpoints.</li><li>`object_storage:read_only` - Allows access to GET information related to your Object Storage.</li><li>`object_storage:read_write` - Allows access to all Object Storage endpoints.</li><li>`stackscripts:read_only` - Allows access to GET your StackScripts.</li><li>`stackscripts:read_write` - Allows access to all endpoints related to your StackScripts.</li><li>`volumes:read_only` - Allows access to GET your Volumes.</li><li>`volumes:read_write` - Allows access to all endpoints related to your Volumes.</li></ul><br/>|
146+
| **Scopes** | <ul><li>`account:read_only` - Allows access to GET information about your Account.</li><li>`account:read_write` - Allows access to all endpoints related to your Account.</li><li>`databases:read_only` - Allows access to GET Managed Databases on your Account.</li><li>`databases:read_write` - Allows access to all endpoints related to your Managed Databases.</li><li>`domains:read_only` - Allows access to GET Domains on your Account.</li><li>`domains:read_write` - Allows access to all Domain endpoints.</li><li>`events:read_only` - Allows access to GET your Events.</li><li>`events:read_write` - Allows access to all endpoints related to your Events.</li><li>`firewall:read_only` - Allows access to GET information about your Firewalls.</li><li>`firewall:read_write` - Allows access to all Firewall endpoints.</li><li>`images:read_only` - Allows access to GET your Images.</li><li>`images:read_write` - Allows access to all endpoints related to your Images.</li><li>`ips:read_only` - Allows access to GET your ips.</li><li>`ips:read_write` - Allows access to all endpoints related to your ips.</li><li>`linodes:read_only` - Allows access to GET Linodes on your Account.</li><li>`linodes:read_write` - Allow access to all endpoints related to your Linodes.</li><li>`lke:read_only` - Allows access to GET LKE Clusters on your Account.</li><li>`lke:read_write` - Allows access to all endpoints related to LKE Clusters on your Account.</li><li>`longview:read_only` - Allows access to GET your Longview Clients.</li><li>`longview:read_write` - Allows access to all endpoints related to your Longview Clients.</li><li>`maintenance:read_only` - Allows access to GET information about Maintenance on your account.</li><li>`nodebalancers:read_only` - Allows access to GET NodeBalancers on your Account.</li><li>`nodebalancers:read_write` - Allows access to all NodeBalancer endpoints.</li><li>`object_storage:read_only` - Allows access to GET information related to your Object Storage.</li><li>`object_storage:read_write` - Allows access to all Object Storage endpoints.</li><li>`stackscripts:read_only` - Allows access to GET your StackScripts.</li><li>`stackscripts:read_write` - Allows access to all endpoints related to your StackScripts.</li><li>`volumes:read_only` - Allows access to GET your Volumes.</li><li>`volumes:read_write` - Allows access to all endpoints related to your Volumes.</li></ul><br/>|
147147

148148
## Requests
149149

@@ -3158,7 +3158,8 @@ paths:
31583158
For more detailed information on a particular Database instance, make a request to its `instance_uri`.
31593159
security:
31603160
- personalAccessToken: []
3161-
- oauth: []
3161+
- oauth:
3162+
- databases:read_only
31623163
responses:
31633164
'200':
31643165
description: Returns a paginated list of all accessible Managed Databases on your Account.
@@ -3201,7 +3202,8 @@ paths:
32013202
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
32023203
security:
32033204
- personalAccessToken: []
3204-
- oauth: []
3205+
- oauth:
3206+
- databases:read_only
32053207
responses:
32063208
'200':
32073209
description: Returns a paginated list of all accessible Managed MySQL Databases on your Account.
@@ -3262,7 +3264,8 @@ paths:
32623264
* To modify update the maintenance window for a Database, use the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.
32633265
security:
32643266
- personalAccessToken: []
3265-
- oauth: []
3267+
- oauth:
3268+
- databases:read_write
32663269
requestBody:
32673270
description: Information about the Managed MySQL Database you are creating.
32683271
x-linode-cli-allowed-defaults:
@@ -3340,7 +3343,8 @@ paths:
33403343
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
33413344
security:
33423345
- personalAccessToken: []
3343-
- oauth: []
3346+
- oauth:
3347+
- databases:read_only
33443348
responses:
33453349
'200':
33463350
description: Returns information for a single Managed MySQL Database.
@@ -3376,7 +3380,8 @@ paths:
33763380
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
33773381
security:
33783382
- personalAccessToken: []
3379-
- oauth: []
3383+
- oauth:
3384+
- databases:read_write
33803385
responses:
33813386
'200':
33823387
description: Managed MySQL Database successfully deleted.
@@ -3427,7 +3432,8 @@ paths:
34273432
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.
34283433
security:
34293434
- personalAccessToken: []
3430-
- oauth: []
3435+
- oauth:
3436+
- databases:read_write
34313437
requestBody:
34323438
description: Updated information for the Managed MySQL Database.
34333439
required: true
@@ -3514,7 +3520,8 @@ paths:
35143520
Database `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.
35153521
security:
35163522
- personalAccessToken: []
3517-
- oauth: []
3523+
- oauth:
3524+
- databases:read_write
35183525
responses:
35193526
'200':
35203527
description: Returns a paginated list of backups for the Managed MySQL Database.
@@ -3559,7 +3566,8 @@ paths:
35593566
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
35603567
security:
35613568
- personalAccessToken: []
3562-
- oauth: []
3569+
- oauth:
3570+
- databases:read_write
35633571
requestBody:
35643572
description: Information about the snapshot backup to create.
35653573
content:
@@ -3647,7 +3655,8 @@ paths:
36473655
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
36483656
security:
36493657
- personalAccessToken: []
3650-
- oauth: []
3658+
- oauth:
3659+
- databases:read_write
36513660
responses:
36523661
'200':
36533662
description: Returns a single backup for the Managed MySQL Database.
@@ -3702,7 +3711,8 @@ paths:
37023711
**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
37033712
security:
37043713
- personalAccessToken: []
3705-
- oauth: []
3714+
- oauth:
3715+
- databases:read_write
37063716
responses:
37073717
'200':
37083718
description: Request to restore backup successful.
@@ -3747,7 +3757,8 @@ paths:
37473757
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
37483758
security:
37493759
- personalAccessToken: []
3750-
- oauth: []
3760+
- oauth:
3761+
- databases:read_only
37513762
responses:
37523763
'200':
37533764
description: Managed Database root username and password.
@@ -3796,7 +3807,8 @@ paths:
37963807
**Note**: Note that it may take several seconds for credentials to reset.
37973808
security:
37983809
- personalAccessToken: []
3799-
- oauth: []
3810+
- oauth:
3811+
- databases:read_write
38003812
responses:
38013813
'200':
38023814
description: Managed Database instance credentials successfully reset.
@@ -3841,7 +3853,8 @@ paths:
38413853
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
38423854
security:
38433855
- personalAccessToken: []
3844-
- oauth: []
3856+
- oauth:
3857+
- databases:read_only
38453858
responses:
38463859
'200':
38473860
description: Returns the SSL CA certificate of a single Managed MySQL Database.
@@ -3892,7 +3905,8 @@ paths:
38923905
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.
38933906
security:
38943907
- personalAccessToken: []
3895-
- oauth: []
3908+
- oauth:
3909+
- databases:read_write
38963910
responses:
38973911
'200':
38983912
description: Managed Database instance patch request successful.

0 commit comments

Comments
 (0)