add api docs create awarding

2018-03-31 00:25:23 +02:00 · 2018-03-31 00:25:23 +02:00 · 053c9730ef
parent 03eae2fc4b
commit 053c9730ef
1 changed files with 16 additions and 0 deletions
--- a/api/apib/army-management/awardings.apib
+++ b/api/apib/army-management/awardings.apib
@ -23,3 +23,19 @@ List all awardings
 + Response 200

    + Attributes (array[Awarding], fixed-type)
+
+### Create Awarding [POST /awardings]
+
+Create a new awarding which is immediatly assigned to the user (only for HL and above permission)
+
+ Request (application/json)
+
+    + Attributes
+        + userId: `5ab68d42f547ed304064e5f7` (string, required) - display name of the user
+        + decorationId: `5abd3dff6e6a0334d95b8ba0` (string, required) - unique id of the decoration
+        + reason: `Good boy` (string, required) - reason for giving the awarding
+        + proposer: `5ab68ceef547ed304064e5f6` (string, required) - app user id, who requested this awarding
+
+ Response 201
+
+    + Attributes (Awarding, fixed-type)