Skip to content

Commit 58f2a4e

Browse files
author
Steve Szyszkiewicz
committed
cleanup account settings docs
1 parent 45167cd commit 58f2a4e

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

docs/src/data/objects/account.yaml

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,62 @@
11
# vim: set et ts=2 sw=2 tw=80 :
22
name: Account
33
prefix: account/settings
4-
description:
4+
description: >
5+
A representation of account settings.
56
schema:
67
address_1:
8+
type: String
9+
description: First line of this account's address.
710
value: 123 Main St.
8-
type: string
911
address_2:
12+
type: String
13+
description: Second line of this account's address.
1014
value: Suite 101
11-
type: string
1215
city:
16+
type: String
17+
description: City portion of this account's address.
1318
value: Philadelphia
14-
type: string
1519
company:
20+
type: String
21+
description: This account's company name.
1622
value: My Company LLC
17-
type: string
1823
country:
24+
type: String
25+
description: Country portion of this account's address.
1926
value: US
20-
type: string
2127
email:
28+
type: String
29+
description: Email address associated with the account.
2230
23-
type: string
2431
first_name:
32+
type: String
33+
description: This account holder's first name.
2534
value: John
26-
type: string
2735
last_name:
36+
type: String
37+
description: This account holder's last name.
2838
value: Smith
29-
type: string
3039
network_helper:
31-
value: true
32-
type: boolean
40+
type: Boolean
3341
description: Enables network helper by default across all users.
42+
value: true
3443
phone:
44+
type: String
45+
description: Phone number associated with the account.
3546
value: 555-555-1212
36-
type: string
3747
state:
48+
type: String
49+
description: State portion of this account's address.
3850
value: PA
39-
type: string
4051
zip:
52+
type: String
53+
description: Zip Code portion of this account's address.
4154
value: 19102
42-
type: string
4355
balance:
56+
type: Float
57+
description: This account's balance (in US Dollars).
4458
value: 0.00
45-
type: float
4659
longview_subscription:
47-
value: null
48-
type: string
60+
type: String
4961
description: The Longview Pro tier you are currently subscribed to.
62+
value: null

0 commit comments

Comments
 (0)