From 9d706641869eacf46efb05ac9bcc48f2e7d1a2cd Mon Sep 17 00:00:00 2001
From: HardiReady <hardi@noarch.de>
Date: Sun, 1 Apr 2018 16:32:44 +0200
Subject: [PATCH] Add needed permission level info for docs

---
 api/apib/admin/account.apib               | 6 ++++++
 api/apib/admin/signature.apib             | 2 ++
 api/apib/army-management/decorations.apib | 6 ++++++
 api/apib/army-management/ranks.apib       | 6 ++++++
 api/apib/army-management/squads.apib      | 6 ++++++
 api/apib/army-management/users.apib       | 6 ++++++
 api/apib/statistics/campaigns.apib        | 4 ++++
 api/apib/statistics/wars.apib             | 4 ++++
 8 files changed, 40 insertions(+)

diff --git a/api/apib/admin/account.apib b/api/apib/admin/account.apib
index 3e9084e..90e86a9 100644
--- a/api/apib/admin/account.apib
+++ b/api/apib/admin/account.apib
@@ -2,6 +2,8 @@
 
 List all app users, ordered by username
 
+*Permission: 4*
+
 + Response 200 (application/json; charset=utf-8)
 
     + Attributes (array[AppUser], fixed-type)
@@ -11,6 +13,8 @@ List all app users, ordered by username
 
 Update an app user, identified by its id
 
+*Permission: 4*
+
 + Parameters
     + id: `5abf5064861d950f157c4a09` (string, required) - unique id of app user
 
@@ -25,6 +29,8 @@ Update an app user, identified by its id
 
 ### Delete App User [DELETE /account/{id}]
 
+*Permission: 4*
+
 Delete an app user
 
 + Parameters
diff --git a/api/apib/admin/signature.apib b/api/apib/admin/signature.apib
index bb8cda2..4f39648 100644
--- a/api/apib/admin/signature.apib
+++ b/api/apib/admin/signature.apib
@@ -2,6 +2,8 @@
 
 Update an army members signature image
 
+*Permission: 4*
+
 + Parameters
     + userId: `5ab68d42f547ed304064e5f7` (string, required) - army members unique user id
 
diff --git a/api/apib/army-management/decorations.apib b/api/apib/army-management/decorations.apib
index 4ba3a3b..a29cb4e 100644
--- a/api/apib/army-management/decorations.apib
+++ b/api/apib/army-management/decorations.apib
@@ -34,6 +34,8 @@ Retrieve single decoration data
 
 Create a new decoration
 
+*Permission: 2*
+
 + Request (multipart/form-data; boundary=---BOUNDARY)
 
         -----BOUNDARY
@@ -73,6 +75,8 @@ Create a new decoration
 
 Update decoration, identified by its id
 
+*Permission: 2*
+
 + Parameters
     + id: `5abeb420b987672bb1ede643` (string, required) - unique id of the decoration
 
@@ -115,6 +119,8 @@ Update decoration, identified by its id
 
 Delete a decoration
 
+*Permission: 2*
+
 + Parameters
     + id: `5abeb43cb987672bb1ede644` (string, required) - unique id of the decoration
 
diff --git a/api/apib/army-management/ranks.apib b/api/apib/army-management/ranks.apib
index bc5e39b..ca92b4f 100644
--- a/api/apib/army-management/ranks.apib
+++ b/api/apib/army-management/ranks.apib
@@ -33,6 +33,8 @@ Retrieve single rank data
 
 Create a new rank
 
+*Permission: 2*
+
 + Request (multipart/form-data; boundary=---BOUNDARY)
 
         -----BOUNDARY
@@ -67,6 +69,8 @@ Create a new rank
 
 Update rank, identified by its id
 
+*Permission: 2*
+
 + Parameters
     + id: `5abeb23995cf43205225710b` (string, required) - unique id of the rank
 
@@ -104,6 +108,8 @@ Update rank, identified by its id
 
 Delete a rank
 
+*Permission: 2*
+
 + Parameters
     + id: `5abeb1b995cf43205225710a` (string, required) - unique id of the rank
 
diff --git a/api/apib/army-management/squads.apib b/api/apib/army-management/squads.apib
index 046bcb9..27d61d9 100644
--- a/api/apib/army-management/squads.apib
+++ b/api/apib/army-management/squads.apib
@@ -32,6 +32,8 @@ Get single squad information
 
 Create a new squad
 
+*Permission: 2*
+
 + Request (multipart/form-data; boundary=---BOUNDARY)
 
         -----BOUNDARY
@@ -61,6 +63,8 @@ Create a new squad
 
 Update squad, identified by its id
 
+*Permission: 2*
+
 + Parameters
     + id: `5abe166f8b7488392a623f12` (string, required) - unique id of the squad
 
@@ -98,6 +102,8 @@ Update squad, identified by its id
 
 Delete a squad
 
+*Permission: 2*
+
 + Parameters
     + id: `5abe16f98b7488392a623f17` (string, required) - unique id of the squad
 
diff --git a/api/apib/army-management/users.apib b/api/apib/army-management/users.apib
index c581371..5108038 100644
--- a/api/apib/army-management/users.apib
+++ b/api/apib/army-management/users.apib
@@ -48,6 +48,8 @@ Get single army member information
 
 Create a new army member
 
+*Permission: 2*
+
 + Request (application/json)
 
     + Attributes
@@ -61,6 +63,8 @@ Create a new army member
 
 Update an army member, identified by its id
 
+*Permission: 2*
+
 + Parameters
     + id: `5abd4780396bc0487068be0e` (string, required) - unique id of army-member
 
@@ -81,6 +85,8 @@ Update an army member, identified by its id
 
 Delete an army member
 
+*Permission: 2*
+
 + Parameters
     + id: `5abd4780396bc0487068be0e` (string, required) - unique id of army-member
 
diff --git a/api/apib/statistics/campaigns.apib b/api/apib/statistics/campaigns.apib
index 83b5d9f..e3e4207 100644
--- a/api/apib/statistics/campaigns.apib
+++ b/api/apib/statistics/campaigns.apib
@@ -13,6 +13,8 @@ Get single campaign information
 
 Create a new campaign
 
+*Permission: 3*
+
 + Request Create new army member (application/json)
 
     + Attributes
@@ -26,6 +28,8 @@ Create a new campaign
 
 Delete a campaign
 
+*Permission: 3*
+
 + Parameters
     + id: `5abd58989e30a76bfef747e6` (string, required) - unique id of campaign
 
diff --git a/api/apib/statistics/wars.apib b/api/apib/statistics/wars.apib
index 16f2b73..333a472 100644
--- a/api/apib/statistics/wars.apib
+++ b/api/apib/statistics/wars.apib
@@ -22,6 +22,8 @@ Retrieve single war data
 
 Create a new war
 
+*Permission: 3*
+
 *NOTE: First line of the log file sent should be NOT beginning of actual game logs! This might result in unparsable line.*
 
 + Request (multipart/form-data; boundary=---BOUNDARY)
@@ -78,6 +80,8 @@ Create a new war
 
 Delete a war
 
+*Permission: 3*
+
 + Parameters
     + id: `5abf65d83fc5fa349ffd5cbb` (string, required) - unique id of the war