Skip to content

Commit d698580

Browse files
authored
Merge pull request #2678 from SzySteve/docs/profile
profile docs updates
2 parents 4307e2d + 07636d2 commit d698580

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/src/data/endpoints/account.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ endpoints:
319319
group: Users
320320
type: resource
321321
description: >
322-
Manage grants for restricted users. It is an error to call this endpoint for unrestrcited users. Only unrestricted
322+
Manage grants for restricted users. It is an error to call this endpoint for unrestricted users. Only unrestricted
323323
users may access this endpoint.
324324
methods:
325325
GET:

docs/src/data/objects/profile.yaml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,27 @@ schema:
3232
code:
3333
type: String
3434
value: rcg3340777c21fa49a5beb971ca1aec44bc584333
35-
description: an alphanumeric code unique to each user for use in creating referral URLs.
35+
description: An alphanumeric code unique to each user for use in creating referral URLs.
3636
url:
3737
type: String
3838
value: https://www.linode.com/?r=rcg3340777c21fa49a5beb971ca1aec44bc584333
3939
description: referral URL based on `code`.
4040
total:
4141
type: Integer
4242
value: 10
43-
description: otal number of referrals attributed to user.
43+
description: Total number of referrals attributed to user.
4444
completed:
4545
type: Integer
4646
value: 8
47-
description: otal number of referrals attributed to user that have converted to full accounts.
47+
description: Total number of referrals attributed to user that have converted to full accounts.
4848
pending:
4949
type: Integer
5050
value: 2
51-
description: otal number of referrals attributed to user that have not yet converted to full accounts.
51+
description: Total number of referrals attributed to user that have not yet converted to full accounts.
5252
credit:
5353
type: Integer
5454
value: 160
55-
description: dollar amount of credit based on completed referrals.
55+
description: US Dollar amount of credit based on completed referrals.
5656
ip_whitelist_enabled:
5757
type: Boolean
5858
value: true
@@ -77,6 +77,12 @@ schema:
7777
value: true
7878
description: Toggles whether two factor authentication (TFA) is enabled or disabled.
7979
editable: true
80+
restricted:
81+
type: Boolean
82+
description: Whether or not this user is restricted. Restricted users are granted access to specific
83+
resources with grants.
84+
seeAlso: ["/reference/endpoints/account/users/$username/grants"]
85+
value: False
8086
enums:
8187
LishSetting:
8288
password_keys: Allow both password and key authentication

0 commit comments

Comments
 (0)