Skip to content

Commit 9678613

Browse files
author
Josh Sager
committed
Addressed PR feedback
1 parent fbae7b7 commit 9678613

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

openapi.yaml

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ paths:
416416
description: >
417417
This endpoint returns a collection of Event objects representing
418418
actions taken on your Account. The events returned depends on your
419-
Grants.
419+
grants.
420420
operationId: getEvents
421421
x-linode-cli-action: list
422422
security:
@@ -1443,10 +1443,10 @@ paths:
14431443
summary: List Users
14441444
description: >
14451445
Returns a paginated list of Users on your account. Users may access all
1446-
or part of your account based on their restricted status and Grants. An
1446+
or part of your account based on their restricted status and grants. An
14471447
unrestricted user may access everything on the account, whereas restricted
14481448
user may only access entities or perform actions they've been given specific
1449-
Grants to.
1449+
grants to.
14501450
operationId: getUsers
14511451
x-linode-cli-action: list
14521452
security:
@@ -1489,7 +1489,7 @@ paths:
14891489
description: >
14901490
Creates a new User on your account. Once created, the user will be
14911491
able to log in and access portions of your account. Access is
1492-
determined by whether or not they are restricted, and what Grants they
1492+
determined by whether or not they are restricted, and what grants they
14931493
have been given.
14941494
operationId: createUser
14951495
x-linode-cli-action: create
@@ -1591,7 +1591,7 @@ paths:
15911591
description: >
15921592
Update information about a user on your account. This can be used to
15931593
change the restricted status of a user. When making a user restricted,
1594-
no Grants will be configured by default and you must then set up Grants
1594+
no grants will be configured by default and you must then set up grants
15951595
in order for the user to access anything on the account.
15961596
operationId: updateUser
15971597
x-linode-cli-action: update
@@ -1634,7 +1634,7 @@ paths:
16341634
summary: Delete User
16351635
description: >
16361636
Deletes a user. The deleted user will be immediately logged out and
1637-
may no longer log in or perform any actions. All Grants that user had
1637+
may no longer log in or perform any actions. All grants that user had
16381638
will be lost.
16391639
operationId: deleteUser
16401640
x-linode-cli-action: delete
@@ -1673,11 +1673,11 @@ paths:
16731673
x-linode-grant: unrestricted only
16741674
tags:
16751675
- account
1676-
summary: View User's Grants
1676+
summary: View User's grants
16771677
description: >
16781678
Returns the full grants structure for this user. This includes all
16791679
entities on the account alongside what level of access this user has
1680-
to each of them. Individual users may view their own Grants at the
1680+
to each of them. Individual users may view their own grants at the
16811681
[/profile/grants](/#operation/getProfileGrants)
16821682
endpoint, but will not see entities that they have no access to.
16831683
operationId: getUserGrants
@@ -1689,14 +1689,14 @@ paths:
16891689
- account:read_only
16901690
responses:
16911691
'200':
1692-
description: The user's Grants.
1692+
description: The user's grants.
16931693
content:
16941694
application/json:
16951695
schema:
16961696
$ref: '#/components/schemas/GrantsResponse'
16971697
'204':
16981698
description: >
1699-
This is an unrestricted user, and therefore has no Grants to return.
1699+
This is an unrestricted user, and therefore has no grants to return.
17001700
This user may access everything on the account and perform all actions.
17011701
default:
17021702
$ref: '#/components/responses/ErrorResponse'
@@ -1709,11 +1709,11 @@ paths:
17091709
x-linode-grant: unrestricted only
17101710
tags:
17111711
- account
1712-
summary: Update User's Grants
1712+
summary: Update User's grants
17131713
description: >
1714-
Update the Grants a user has. This can be used to give a user access
1714+
Update the grants a user has. This can be used to give a user access
17151715
to new entities or actions, or take access away. You do not need to
1716-
include the Grant for every entity on the account in this request; any
1716+
include the grant for every entity on the account in this request; any
17171717
that are not included will remain unchanged.
17181718
operationId: updateUserGrants
17191719
x-linode-cli-action: update-grants
@@ -1723,7 +1723,7 @@ paths:
17231723
- oauth:
17241724
- account:read_write
17251725
requestBody:
1726-
description: The Grants to update. Omitted Grants will be left unchanged.
1726+
description: The grants to update. Omitted grants will be left unchanged.
17271727
required: true
17281728
content:
17291729
application/json:
@@ -2550,7 +2550,7 @@ paths:
25502550
summary: Create Linode
25512551
description: |
25522552
This endpoint allows you to create a new Linode server on your account. In order for this
2553-
request to complete successfully, your user must have the `add_linodes` Grant. Creating a
2553+
request to complete successfully, your user must have the `add_linodes` grant. Creating a
25542554
new Linode will incur a charge on your account.
25552555
25562556
Linodes can be created using one of the available types. See
@@ -3223,7 +3223,7 @@ paths:
32233223
description: >
32243224
You can clone your Linode's existing disks or configuration profiles to
32253225
another Linode on your account. In order for this request to complete
3226-
successfully, your user must have the `add_linodes` Grant. Cloning to a
3226+
successfully, your user must have the `add_linodes` grant. Cloning to a
32273227
new Linode will incur a charge on your account.
32283228
32293229
If cloning to an existing Linode, any actions currently running or
@@ -7733,7 +7733,7 @@ paths:
77337733
This returns a GrantsResponse describing what the acting user has been
77347734
granted access to. For unrestricted users, this will return a 204 and
77357735
no body because unrestricted users have access to everything without
7736-
Grants. This will not return information about entities you do not have
7736+
grants. This will not return information about entities you do not have
77377737
access to. This endpoint is useful when writing third-party OAuth
77387738
applications to see what options you should present to the acting user
77397739
(for example, if they do not have `global.add_linodes`, you might not
@@ -7754,7 +7754,7 @@ paths:
77547754
$ref: '#/components/schemas/GrantsResponse'
77557755
'204':
77567756
description: >
7757-
This is an unrestricted user, who has no Grants. This user can access
7757+
This is an unrestricted user, who has no grants. This user can access
77587758
everything on the account.
77597759
default:
77607760
$ref: '#/components/responses/ErrorResponse'
@@ -8557,7 +8557,7 @@ paths:
85578557
description: >
85588558
This endpoint allows you to create a new Volume on your account. In order
85598559
for this to complete successfully, your user must have the `add_volumes`
8560-
Grant. Creating a new Volume will start accruing additional charges
8560+
grant. Creating a new Volume will start accruing additional charges
85618561
on your account.
85628562
85638563
Volume service may not be available in all regions. See
@@ -8835,7 +8835,7 @@ paths:
88358835
description: >
88368836
This endpoint allows you to create a new Volume on your account. In
88378837
order for this request to complete successfully, your user must have the
8838-
`add_volumes` Grant. The new Volume will have the same size and data as
8838+
`add_volumes` grant. The new Volume will have the same size and data as
88398839
the source Volume. Creating a new Volume will incur a charge on your
88408840
account.
88418841
tags:
@@ -9877,7 +9877,7 @@ components:
98779877
entity related to your Account. For example, booting a Linode would
98789878
create an Event.
98799879
9880-
The events returned depends on your Grants.
9880+
The events returned depends on your grants.
98819881
properties:
98829882
id:
98839883
type: integer
@@ -10050,7 +10050,7 @@ components:
1005010050
id:
1005110051
type: integer
1005210052
description: >
10053-
The ID of the entity this Grant applies to.
10053+
The ID of the entity this grant applies to.
1005410054
example: 123
1005510055
permissions:
1005610056
type: string
@@ -10065,16 +10065,16 @@ components:
1006510065
label:
1006610066
type: string
1006710067
description: >
10068-
The current label of the entity this Grant applies to, for display
10068+
The current label of the entity this grant applies to, for display
1006910069
purposes.
1007010070
example: example-entity
1007110071
readOnly: true
1007210072
GrantsResponse:
1007310073
type: object
1007410074
description: >
10075-
A structure representing all Grants a restricted user has on the
10075+
A structure representing all grants a restricted user has on the
1007610076
account. Not available for unrestricted users, as they have access to
10077-
everything without Grants. If retrieved from the `/profile/grants`
10077+
everything without grants. If retrieved from the `/profile/grants`
1007810078
endpoint, entities to which a user has no access will be omitted.
1007910079
properties:
1008010080
global:
@@ -10134,50 +10134,50 @@ components:
1013410134
items:
1013510135
$ref: '#/components/schemas/Grant'
1013610136
description: >
10137-
The Grants this user has pertaining to Linodes on this account.
10137+
The grants this user has pertaining to Linodes on this account.
1013810138
There will be one entry per Linode on the account.
1013910139
domain:
1014010140
type: array
1014110141
items:
1014210142
$ref: '#/components/schemas/Grant'
1014310143
description: >
10144-
The Grants this user has pertaining to Domains on this account.
10144+
The grants this user has pertaining to Domains on this account.
1014510145
There will be one entry per Domain on the account.
1014610146
nodebalancer:
1014710147
type: array
1014810148
items:
1014910149
$ref: '#/components/schemas/Grant'
1015010150
description: >
10151-
The Grants this user has pertaining to NodeBalancers on this
10152-
account. There will be one entry per NodeBalancer on the account.
10151+
The grants this user has pertaining to NodeBalancers on this
10152+
account. There will be one entry per NodeBalancer on the account.
1015310153
image:
1015410154
type: array
1015510155
items:
1015610156
$ref: '#/components/schemas/Grant'
1015710157
description: >
10158-
The Grants this user has pertaining to Images on this account.
10158+
The grants this user has pertaining to Images on this account.
1015910159
There will be one entry per Image on the account.
1016010160
longview:
1016110161
type: array
1016210162
items:
1016310163
$ref: '#/components/schemas/Grant'
1016410164
description: >
10165-
The Grants this user has pertaining to Longview Clients on this
10166-
account. There will be one entry per Longview Client on the
10165+
The grants this user has pertaining to Longview Clients on this
10166+
account. There will be one entry per Longview Client on the
1016710167
account.
1016810168
stackscript:
1016910169
type: array
1017010170
items:
1017110171
$ref: '#/components/schemas/Grant'
1017210172
description: >
10173-
The Grants this user has pertaining to StackScripts on this
10174-
account. There will be one entry per StackScript on the account.
10173+
The grants this user has pertaining to StackScripts on this
10174+
account. There will be one entry per StackScript on the account.
1017510175
volume:
1017610176
type: array
1017710177
items:
1017810178
$ref: '#/components/schemas/Grant'
1017910179
description: >
10180-
The Grants this user has pertaining to Volumes on this account.
10180+
The grants this user has pertaining to Volumes on this account.
1018110181
There will be one entry per Volume on the account.
1018210182
ImagePrivate:
1018310183
type: object

0 commit comments

Comments
 (0)