Skip to content

Commit aecfd34

Browse files
author
Henry Smith
committed
Add documentation for POST /users
1 parent 15da68a commit aecfd34

File tree

3 files changed

+67
-2
lines changed

3 files changed

+67
-2
lines changed

service/basekit.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name":"BaseKit REST API",
33
"includes":[
4-
"sites.json"
4+
"sites.json",
5+
"users.json"
56
]
67
}

service/sites.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
"CreateSite": {
55
"httpMethod": "POST",
6-
"summary": "Create a new site",
76
"uri": "/sites",
7+
"summary": "Create a new site",
88
"parameters": {
99

1010
"accountHolderRef": {

service/users.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"operations": {
3+
4+
"CreateUser": {
5+
"httpMethod": "POST",
6+
"uri": "/users",
7+
"summary": "Create a new user account",
8+
"parameters": {
9+
10+
"brandRef": {
11+
"description": "Brand in which to create the user.",
12+
"location": "json",
13+
"required": true,
14+
"type": "numeric"
15+
},
16+
17+
"username": {
18+
"description": "",
19+
"location": "json",
20+
"required": true,
21+
"type": "string"
22+
},
23+
24+
"password": {
25+
"description": "Password for the new user. This must be more than 6 characters in length.",
26+
"location": "json",
27+
"required": true,
28+
"type": "string"
29+
},
30+
31+
"email": {
32+
"description": "E-mail address of the user. Must be a valid e-mail address e.g. name@domain.com.",
33+
"location": "json",
34+
"required": true,
35+
"type": "string"
36+
},
37+
38+
"firstName": {
39+
"description": "First name of the user.",
40+
"location": "json",
41+
"required": true,
42+
"type": "string"
43+
},
44+
45+
"lastName": {
46+
"description": "Last name of the user.",
47+
"location": "json",
48+
"required": true,
49+
"type": "string"
50+
},
51+
52+
"languageCode": {
53+
"default": "en",
54+
"description": "Initial language code for the user. This can be manually changed by the user.",
55+
"location": "json",
56+
"required": true,
57+
"type": "string"
58+
}
59+
60+
}
61+
}
62+
63+
}
64+
}

0 commit comments

Comments
 (0)