diff --git a/api/apib/data_structures/_app-user.apib b/api/apib/data_structures/_app-user.apib new file mode 100644 index 0000000..28ec103 --- /dev/null +++ b/api/apib/data_structures/_app-user.apib @@ -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 diff --git a/api/apib/data_structures/_awarding.apib b/api/apib/data_structures/_awarding.apib index 14076a1..e49da85 100644 --- a/api/apib/data_structures/_awarding.apib +++ b/api/apib/data_structures/_awarding.apib @@ -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 + decorationId (Decoration, required) - populated decoration object that is given with 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 + 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 diff --git a/api/apib/data_structures/index.apib b/api/apib/data_structures/index.apib index 013bbdc..2934047 100644 --- a/api/apib/data_structures/index.apib +++ b/api/apib/data_structures/index.apib @@ -1,5 +1,7 @@ # Data Structures +:[Gists](_app-user.apib) + :[Gists](_army.apib) :[Gists](_auth.apib)