Skip to content

Commit c57060c

Browse files
committed
Add more unrestricted user messages
1 parent 235f452 commit c57060c

File tree

1 file changed

+43
-36
lines changed

1 file changed

+43
-36
lines changed

openapi.yaml

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2716,12 +2716,12 @@ paths:
27162716
tags:
27172717
- Account
27182718
summary: Users List
2719-
description: >
2720-
Returns a paginated list of Users on your Account. Users may access all
2721-
or part of your Account based on their restricted status and grants. An
2722-
unrestricted User may access everything on the account, whereas restricted
2723-
User may only access entities or perform actions they've been given specific
2724-
grants to.
2719+
description: |
2720+
Returns a paginated list of Users on your Account.
2721+
2722+
This command can only be accessed by the unrestricted users of an account.
2723+
2724+
Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
27252725
operationId: getUsers
27262726
x-linode-cli-action: list
27272727
security:
@@ -2761,10 +2761,11 @@ paths:
27612761
tags:
27622762
- Account
27632763
summary: User Create
2764-
description: >
2764+
description: |
27652765
Creates a User on your Account. Once created, a confirmation message containing
27662766
password creation and login instructions is sent to the User's email address.
27672767

2768+
This command can only be accessed by the unrestricted users of an account.
27682769

27692770
The User's account access is determined by whether or not they are restricted,
27702771
and what grants they have been given.
@@ -2824,8 +2825,10 @@ paths:
28242825
tags:
28252826
- Account
28262827
summary: User View
2827-
description: >
2828+
description: |
28282829
Returns information about a single User on your Account.
2830+
2831+
This command can only be accessed by the unrestricted users of an account.
28292832
operationId: getUser
28302833
x-linode-cli-action: view
28312834
security:
@@ -2854,11 +2857,13 @@ paths:
28542857
tags:
28552858
- Account
28562859
summary: User Update
2857-
description: >
2860+
description: |
28582861
Update information about a User on your Account. This can be used to
28592862
change the restricted status of a User. When making a User restricted,
28602863
no grants will be configured by default and you must then set up grants
28612864
in order for the User to access anything on the Account.
2865+
2866+
This command can only be accessed by the unrestricted users of an account.
28622867
operationId: updateUser
28632868
x-linode-cli-action: update
28642869
security:
@@ -2902,10 +2907,12 @@ paths:
29022907
tags:
29032908
- Account
29042909
summary: User Delete
2905-
description: >
2910+
description: |
29062911
Deletes a User. The deleted User will be immediately logged out and
29072912
may no longer log in or perform any actions. All of the User's Grants
29082913
will be removed.
2914+
2915+
This command can only be accessed by the unrestricted users of an account.
29092916
operationId: deleteUser
29102917
x-linode-cli-action: delete
29112918
security:
@@ -2944,11 +2951,12 @@ paths:
29442951
tags:
29452952
- Account
29462953
summary: User's Grants View
2947-
description: >
2954+
description: |
29482955
Returns the full grants structure for the specified account User
29492956
(other than the account owner, see below for details). This includes all entities
29502957
on the Account alongside the level of access this User has to each of them.
29512958

2959+
This command can only be accessed by the unrestricted users of an account.
29522960

29532961
The current authenticated User, including the account owner, may view their
29542962
own grants at the [/profile/grants](/docs/api/profile/#grants-list)
@@ -2983,11 +2991,13 @@ paths:
29832991
tags:
29842992
- Account
29852993
summary: User's Grants Update
2986-
description: >
2994+
description: |
29872995
Update the grants a User has. This can be used to give a User access
29882996
to new entities or actions, or take access away. You do not need to
29892997
include the grant for every entity on the Account in this request; any
29902998
that are not included will remain unchanged.
2999+
3000+
This command can only be accessed by the unrestricted users of an account.
29913001
operationId: updateUserGrants
29923002
x-linode-cli-action: update-grants
29933003
x-linode-cli-skip: true
@@ -3729,7 +3739,6 @@ paths:
37293739
- url: https://api.linode.com/v4
37303740
- url: https://api.linode.com/v4beta
37313741
x-linode-cli-action: mongodb-backup-delete
3732-
x-linode-grant: unrestricted only
37333742
description: |
37343743
Delete a single backup for an accessible Managed MongoDB Database.
37353744

@@ -4509,7 +4518,6 @@ paths:
45094518
- url: https://api.linode.com/v4
45104519
- url: https://api.linode.com/v4beta
45114520
x-linode-cli-action: mysql-backup-delete
4512-
x-linode-grant: unrestricted only
45134521
description: |
45144522
Delete a single backup for an accessible Managed MySQL Database.
45154523

@@ -5280,7 +5288,6 @@ paths:
52805288
- url: https://api.linode.com/v4
52815289
- url: https://api.linode.com/v4beta
52825290
x-linode-cli-action: postgresql-backup-delete
5283-
x-linode-grant: unrestricted only
52845291
description: |
52855292
Delete a single backup for an accessible Managed PostgreSQL Database.
52865293

@@ -11548,7 +11555,7 @@ paths:
1154811555
tags:
1154911556
- Managed
1155011557
summary: Managed Contacts List
11551-
description: >
11558+
description: |
1155211559
Returns a paginated list of Managed Contacts on your Account.
1155311560

1155411561
This command can only be accessed by the unrestricted users of an account.
@@ -11591,7 +11598,7 @@ paths:
1159111598
tags:
1159211599
- Managed
1159311600
summary: Managed Contact Create
11594-
description: >
11601+
description: |
1159511602
Creates a Managed Contact. A Managed Contact is someone Linode
1159611603
special forces can contact in the course of attempting to resolve an issue
1159711604
with a Managed Service.
@@ -11653,7 +11660,7 @@ paths:
1165311660
tags:
1165411661
- Managed
1165511662
summary: Managed Contact View
11656-
description: >
11663+
description: |
1165711664
Returns a single Managed Contact.
1165811665

1165911666
This command can only be accessed by the unrestricted users of an account.
@@ -11737,7 +11744,7 @@ paths:
1173711744
tags:
1173811745
- Managed
1173911746
summary: Managed Contact Delete
11740-
description: >
11747+
description: |
1174111748
Deletes a Managed Contact.
1174211749

1174311750
This command can only be accessed by the unrestricted users of an account.
@@ -11775,7 +11782,7 @@ paths:
1177511782
tags:
1177611783
- Managed
1177711784
summary: Managed Credentials List
11778-
description: >
11785+
description: |
1177911786
Returns a paginated list of Managed Credentials on your Account.
1178011787

1178111788
This command can only be accessed by the unrestricted users of an account.
@@ -11818,7 +11825,7 @@ paths:
1181811825
tags:
1181911826
- Managed
1182011827
summary: Managed Credential Create
11821-
description: >
11828+
description: |
1182211829
Creates a Managed Credential. A Managed Credential is stored securely
1182311830
to allow Linode special forces to access your Managed Services and resolve
1182411831
issues.
@@ -11894,7 +11901,7 @@ paths:
1189411901
tags:
1189511902
- Managed
1189611903
summary: Managed Credential View
11897-
description: >
11904+
description: |
1189811905
Returns a single Managed Credential.
1189911906

1190011907
This command can only be accessed by the unrestricted users of an account.
@@ -11983,7 +11990,7 @@ paths:
1198311990
tags:
1198411991
- Managed
1198511992
summary: Managed Credential Username and Password Update
11986-
description: >
11993+
description: |
1198711994
Updates the username and password for a Managed Credential.
1198811995

1198911996
This command can only be accessed by the unrestricted users of an account.
@@ -12053,7 +12060,7 @@ paths:
1205312060
tags:
1205412061
- Managed
1205512062
summary: Managed Credential Delete
12056-
description: >
12063+
description: |
1205712064
Deletes a Managed Credential. Linode special forces will no longer
1205812065
have access to this Credential when attempting to resolve issues.
1205912066

@@ -12089,7 +12096,7 @@ paths:
1208912096
tags:
1209012097
- Managed
1209112098
summary: Managed SSH Key View
12092-
description: >
12099+
description: |
1209312100
Returns the unique SSH public key assigned to your Linode account's
1209412101
Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account,
1209512102
Linode special forces will be able to log in to the Linode with this key
@@ -12140,7 +12147,7 @@ paths:
1214012147
tags:
1214112148
- Managed
1214212149
summary: Managed Issues List
12143-
description: >
12150+
description: |
1214412151
Returns a paginated list of recent and ongoing issues detected on your
1214512152
Managed Services.
1214612153

@@ -12194,7 +12201,7 @@ paths:
1219412201
tags:
1219512202
- Managed
1219612203
summary: Managed Issue View
12197-
description: >
12204+
description: |
1219812205
Returns a single Issue that is impacting or did impact one of your
1219912206
Managed Services.
1220012207

@@ -12232,7 +12239,7 @@ paths:
1223212239
tags:
1223312240
- Managed
1223412241
summary: Managed Linode Settings List
12235-
description: >
12242+
description: |
1223612243
Returns a paginated list of Managed Settings for your Linodes. There will
1223712244
be one entry per Linode on your Account.
1223812245

@@ -12286,7 +12293,7 @@ paths:
1228612293
tags:
1228712294
- Managed
1228812295
summary: Linode's Managed Settings View
12289-
description: >
12296+
description: |
1229012297
Returns a single Linode's Managed settings.
1229112298

1229212299
This command can only be accessed by the unrestricted users of an account.
@@ -12373,7 +12380,7 @@ paths:
1237312380
tags:
1237412381
- Managed
1237512382
summary: Managed Services List
12376-
description: >
12383+
description: |
1237712384
Returns a paginated list of Managed Services on your Account. These
1237812385
are the services Linode Managed is monitoring and will report and attempt
1237912386
to resolve issues with.
@@ -12418,7 +12425,7 @@ paths:
1241812425
tags:
1241912426
- Managed
1242012427
summary: Managed Service Create
12421-
description: >
12428+
description: |
1242212429
Creates a Managed Service. Linode Managed will begin monitoring this
1242312430
service and reporting and attempting to resolve any Issues.
1242412431

@@ -12494,7 +12501,7 @@ paths:
1249412501
tags:
1249512502
- Managed
1249612503
summary: Managed Service View
12497-
description: >
12504+
description: |
1249812505
Returns information about a single Managed Service on your Account.
1249912506

1250012507
This command can only be accessed by the unrestricted users of an account.
@@ -12526,7 +12533,7 @@ paths:
1252612533
tags:
1252712534
- Managed
1252812535
summary: Managed Service Update
12529-
description: >
12536+
description: |
1253012537
Updates information about a Managed Service.
1253112538

1253212539
This command can only be accessed by the unrestricted users of an account.
@@ -12586,7 +12593,7 @@ paths:
1258612593
tags:
1258712594
- Managed
1258812595
summary: Managed Service Delete
12589-
description: >
12596+
description: |
1259012597
Deletes a Managed Service. This service will no longer be monitored by
1259112598
Linode Managed.
1259212599

@@ -12629,7 +12636,7 @@ paths:
1262912636
tags:
1263012637
- Managed
1263112638
summary: Managed Service Disable
12632-
description: >
12639+
description: |
1263312640
Temporarily disables monitoring of a Managed Service.
1263412641

1263512642
This command can only be accessed by the unrestricted users of an account.
@@ -12672,7 +12679,7 @@ paths:
1267212679
tags:
1267312680
- Managed
1267412681
summary: Managed Service Enable
12675-
description: >
12682+
description: |
1267612683
Enables monitoring of a Managed Service.
1267712684

1267812685
This command can only be accessed by the unrestricted users of an account.

0 commit comments

Comments
 (0)