forked from A-Team-Rowan-University/a-team-website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathusers.apib
54 lines (43 loc) · 1.25 KB
/
users.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
## Data Structures
### User
+ id: 42 (number, required)
+ first_name: Tim (string, required)
+ last_name: Hollabaugh (string, required)
+ banner_id: 916000000 (number, required)
+ email: [email protected] (string)
### New User
+ first_name: Tim (string, required)
+ last_name: Hollabaugh (string, required)
+ banner_id: 916000000 (number, required)
+ email: [email protected] (string)
### Partial User
+ first_name: Tim (string)
+ last_name: Hollabaugh (string)
+ banner_id: 916000000 (number)
+ email: [email protected] (string)
# Group Users
The users
## Users [/api/v1/users/]
### List all users [GET]
This lists all the users in the system
+ Response 200 (application/json)
+ Attributes
+ users (array[User])
### Create a user [POST]
This creates a new user
+ Request (application/json)
+ Attributes (New User)
+ Response 200 (application/json)
+ Attributes (User)
## User [/api/v1/users/{user_id}]
+ Parameters
+ user_id: 1 (required, number)
### Get a single user [GET]
+ Response 200 (application/json)
+ Attributes (User, required)
### Update a user [PUT]
+ Request (application/json)
+ Attributes (Partial User, required)
+ Response 204
### Delete a user [DELETE]
+ Response 204