From 7d3bf9a4261d0e353c27a765bdea8b88151b08d4 Mon Sep 17 00:00:00 2001
From: HardiReady <hardi@noarch.de>
Date: Thu, 29 Mar 2018 23:22:37 +0200
Subject: [PATCH] Add campaign apib docs

---
 api/apib/data_structures/_campaign.apib |  9 +++++++
 api/apib/data_structures/index.apib     |  2 ++
 api/apib/dev-doc.apib                   |  2 ++
 api/apib/dredd/data/app_user.json       |  2 +-
 api/apib/dredd/data/campaign.json       |  2 ++
 api/apib/dredd/data/user.json           |  2 +-
 api/apib/statistics/campaigns.apib      | 33 +++++++++++++++++++++++++
 7 files changed, 50 insertions(+), 2 deletions(-)
 create mode 100644 api/apib/data_structures/_campaign.apib
 create mode 100644 api/apib/statistics/campaigns.apib

diff --git a/api/apib/data_structures/_campaign.apib b/api/apib/data_structures/_campaign.apib
new file mode 100644
index 0000000..4470bc5
--- /dev/null
+++ b/api/apib/data_structures/_campaign.apib
@@ -0,0 +1,9 @@
+# Campaign (object)
+Campaign entity
+
+## Properties
++ _id:`5abd55ea9e30a76bfef747d6` (string, required) - unique id of the campaign
++ title: `Ein Kessel Buntes` (string, required) - display title of the campaign
++ timestamp: `2017-05-17T19:44:28.751Z` (string, required) - creation date
++ updatedAt: `"2017-05-17T19:44:28.751Z` (string, required) - version date
++ __v: 0 (number, required) - version number
diff --git a/api/apib/data_structures/index.apib b/api/apib/data_structures/index.apib
index 111d484..14d3ada 100644
--- a/api/apib/data_structures/index.apib
+++ b/api/apib/data_structures/index.apib
@@ -8,6 +8,8 @@
 
 :[Gists](_awarding.apib)
 
+:[Gists](_campaign.apib)
+
 :[Gists](_decoration.apib)
 
 :[Gists](_promotion.apib)
diff --git a/api/apib/dev-doc.apib b/api/apib/dev-doc.apib
index 66adeef..ea40120 100644
--- a/api/apib/dev-doc.apib
+++ b/api/apib/dev-doc.apib
@@ -32,6 +32,8 @@ FORMAT: 1A
 
 # Group Campaigns
 
+:[Gists](statistics/campaigns.apib)
+
 # Group Decorations
 
 :[Gists](army-management/decorations.apib)
diff --git a/api/apib/dredd/data/app_user.json b/api/apib/dredd/data/app_user.json
index 5e14cc3..c1a1782 100644
--- a/api/apib/dredd/data/app_user.json
+++ b/api/apib/dredd/data/app_user.json
@@ -1 +1 @@
-{"_id":{"$oid":"5ab68ceef547ed304064e5f6"},"squad":null,"permission":4,"activated":true,"username":"testuser","secret":"my secret","password":"$2a$10$wvgBbcckHrFu8Ctw8hSPNuFLoBy4sRubioyiK1NabOC0UgYD.KITi","timestamp":{"$date":"2018-03-24T17:37:50.668Z"},"updatedAt":{"$date":"2018-03-24T17:37:50.668Z"},"__v":0}
+{"_id":{"$oid":"5ab68ceef547ed304064e5f6"},"squad":{"$oid":"5aba54eaeadcce6332c6a774"},"permission":4,"activated":true,"username":"testuser","secret":"my secret","password":"$2a$10$wvgBbcckHrFu8Ctw8hSPNuFLoBy4sRubioyiK1NabOC0UgYD.KITi","timestamp":{"$date":"2018-03-24T17:37:50.668Z"},"updatedAt":{"$date":"2018-03-24T17:37:50.668Z"},"__v":0}
diff --git a/api/apib/dredd/data/campaign.json b/api/apib/dredd/data/campaign.json
index e69de29..2c31b97 100644
--- a/api/apib/dredd/data/campaign.json
+++ b/api/apib/dredd/data/campaign.json
@@ -0,0 +1,2 @@
+{"_id":{"$oid":"5abd55ea9e30a76bfef747d6"},"title":"Ein Kessel Buntes","timestamp":{"$date":"2018-03-29T21:08:58.123Z"},"updatedAt":{"$date":"2018-03-29T21:08:58.123Z"},"__v":0}
+{"_id":{"$oid":"5abd58989e30a76bfef747e6"},"title":"This Is The End","timestamp":{"$date":"2018-03-29T21:20:24.558Z"},"updatedAt":{"$date":"2018-03-29T21:20:24.558Z"},"__v":0}
diff --git a/api/apib/dredd/data/user.json b/api/apib/dredd/data/user.json
index e84e3e5..7d0906a 100644
--- a/api/apib/dredd/data/user.json
+++ b/api/apib/dredd/data/user.json
@@ -1,2 +1,2 @@
-{"_id":{"$oid":"5ab68d42f547ed304064e5f7"},"rankLvl":0,"squadId":{"$oid":"5aba54eaeadcce6332c6a774"},"username":"hardiready","updatedAt":{"$date":"2018-03-27T14:28:04.533Z"},"__v":0}
 {"_id":{"$oid":"5abd4780396bc0487068be0e"},"rankLvl":0,"squadId":null,"username":"KalleK","timestamp":{"$date":"2018-03-29T20:07:28.960Z"},"updatedAt":{"$date":"2018-03-29T20:07:28.960Z"},"__v":0}
+{"_id":{"$oid":"5ab68d42f547ed304064e5f7"},"rankLvl":0,"squadId":{"$oid":"5aba54eaeadcce6332c6a774"},"username":"hardiready","updatedAt":{"$date":"2018-03-27T14:28:04.533Z"},"__v":0}
diff --git a/api/apib/statistics/campaigns.apib b/api/apib/statistics/campaigns.apib
new file mode 100644
index 0000000..3974a78
--- /dev/null
+++ b/api/apib/statistics/campaigns.apib
@@ -0,0 +1,33 @@
+### Get User [GET /campaigns/{id}]
+
+Get single campaign information
+
++ Parameters
+    + id: `5abd55ea9e30a76bfef747d6` (string, required) - unique id of campaign
+
++ Response 200
+
+    + Attributes (Campaign, fixed-type)
+
+### Create Campaign [POST /campaigns]
+
+Create a new campaign
+
++ Request Create new army member (application/json)
+
+    + Attributes
+        + title: `Return To Kessel In A Schmelz` (string, required) - display name of the campaign
+
++ Response 201
+
+    + Attributes (Campaign, fixed-type)
+
+### Delete Campaign [DELETE /campaigns/{id}]
+
+Delete a campaign
+
++ Parameters
+    + id: `5abd58989e30a76bfef747e6` (string, required) - unique id of campaign
+
++ Response 204
+