From ea96bca9915f5e2c9dd0a2c56d8d2975278b26f7 Mon Sep 17 00:00:00 2001
From: HardiReady <hardi@noarch.de>
Date: Sun, 25 Mar 2018 21:18:13 +0200
Subject: [PATCH] Add get users apib docs

---
 api/apib/army-management/users.apib      | 28 ++++++++++++++++++++++++
 api/apib/data_structures/_promotion.apib |  2 +-
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/api/apib/army-management/users.apib b/api/apib/army-management/users.apib
index 3d047a7..d0c6159 100644
--- a/api/apib/army-management/users.apib
+++ b/api/apib/army-management/users.apib
@@ -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
diff --git a/api/apib/data_structures/_promotion.apib b/api/apib/data_structures/_promotion.apib
index 0e45c7e..4c8a7ad 100644
--- a/api/apib/data_structures/_promotion.apib
+++ b/api/apib/data_structures/_promotion.apib
@@ -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