Add get users apib docs

pull/32/head
HardiReady 2018-03-25 21:18:13 +02:00
parent b85f987088
commit ea96bca991
2 changed files with 29 additions and 1 deletions

View File

@ -1,3 +1,31 @@
### GET Users [GET /users{?q,fractFilter,limit,offset}]
Get single army member information
+ Parameters
+ q: `hardi` (string, optional) - filter string which filters for partial username
+ fractFilter (enum[string], optional)
Field to filter by fraction
+ Members
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
+ limit: 20 (number, optional)
Maximum number of users to return
+ offset (number, optional)
Offset into result-set (useful for pagination)
+ Default: 0
+ Response 200
+ Attributes (array[User])
### GET User [GET /users/{id}]
Get single army member information

View File

@ -6,7 +6,7 @@ Representation of a promotion request for a army member
+ confirmed: 0 (number, required) - number representing status of the promotion (0 - in progress, 1 - approved, 2 - rejected)
+ newRankLvl: 14 - new rank level that is requested in this promotion
+ oldRankLvl: 10 - old rank level of the user
+ proposer: (Proposer, required) - app user who requested the promotion
+ proposer (Proposer, required) - app user who requested the promotion
+ timestamp: `2018-03-25T18:54:21.609Z` (string, required) - creation timestamp
+ updatedAt: `2018-03-25T18:54:21.609Z` (string, required) - version timestamp
+ userId (User, required) - populated user instance of user the promotion is requested for