hardi
/
opt-cc
1
0
Fork 0
Code Pull Requests Releases 47 Activity

Add proposer for awardings docs

pull/32/head
HardiReady 2018-03-25 20:44:19 +02:00
parent dc0de2db89
commit e2722afee7
3 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/apib/data_structures/_app-user.apib Normal file
View File

@ -0,0 +1,8 @@
# Proposer (object)
Representation of an app user who proposed an awarding or a promotion
## Properties
+ _id: `593d5e3f72d35225222bcaba` (string, required) - unique id of the app user
+ username: `hardiready` (string, required) - username of the app user
+ squad: `591470249e9fae286e308e41` (string, required) - squad id associated with the app user

1
api/apib/data_structures/_awarding.apib
View File

@ -7,6 +7,7 @@ Awarding associating a decoration to a user
+ date: `2017-05-17T19:44:24.926Z` (string, required) - date when the awarding was requested + date: `2017-05-17T19:44:24.926Z` (string, required) - date when the awarding was requested
+ decorationId (Decoration, required) - populated decoration object that is given with the awarding + decorationId (Decoration, required) - populated decoration object that is given with the awarding
+ reason: `war dabei` (string, required) - reason for giving the awarding + reason: `war dabei` (string, required) - reason for giving the awarding
+ proposer (Proposer, required) - app user who requested this awarding, null if awarding was given directly
+ timestamp: `2017-05-17T19:44:28.751Z` (string, required) - creation date + timestamp: `2017-05-17T19:44:28.751Z` (string, required) - creation date
+ updatedAt: `"2017-05-17T19:44:28.751Z` (string, required) - version date + updatedAt: `"2017-05-17T19:44:28.751Z` (string, required) - version date
+ userId: `5918d2ca574b0b1d820a0b24` (string, required) - the unique id of the user who got this awarding + userId: `5918d2ca574b0b1d820a0b24` (string, required) - the unique id of the user who got this awarding

2
api/apib/data_structures/index.apib
View File

@ -1,5 +1,7 @@
# Data Structures # Data Structures
:[Gists](_app-user.apib)
:[Gists](_army.apib) :[Gists](_army.apib)
:[Gists](_auth.apib) :[Gists](_auth.apib)