hardi
/
opt-cc
1
0
Fork 0
Code Pull Requests Releases 47 Activity

Update API docs for wars & campaigns following CC-62 changes

pull/46/head
HardiReady 2018-10-18 20:56:06 +02:00
parent 9fb39b0af2
commit 229b133777
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
api/apib/statistics/campaigns.apib
View File

@ -2,7 +2,6 @@
Get all campaigns information Get all campaigns information
+ Response 200 (application/json; charset=utf-8) + Response 200 (application/json; charset=utf-8)
+ Attributes (array[Campaign], fixed-type) + Attributes (array[Campaign], fixed-type)
@ -18,6 +17,18 @@ Get single campaign information
+ Attributes (Campaign, fixed-type) + Attributes (Campaign, fixed-type)
### Get Campaign Containing Specific War [GET /campaigns/with/war/{warId}]
Get a single campaign, containing a specific war
+ Parameters
+ warId: `5abf65ae3fc5fa349ffd5ca3` (string, required) - unique id of war that has to be part of campaign
+ Response 200 (application/json; charset=utf-8)
+ Attributes (Campaign, fixed-type)
### Create Campaign [POST /campaigns] ### Create Campaign [POST /campaigns]
Create a new campaign Create a new campaign

7
api/apib/statistics/wars.apib
View File

@ -1,10 +1,13 @@
### List Wars [GET /wars] ### List Wars [GET /wars{?campaignId}]
List all wars, subordinate to their campaign List all wars, subordinate to their campaign
+ Parameters
+ campaignId: `5abd55ea9e30a76bfef747d6` (string, optional) - show only wars from campaign with this id
+ Response 200 (application/json; charset=utf-8) + Response 200 (application/json; charset=utf-8)
+ Attributes (array[WarCampaign], fixed-type) + Attributes (array[War], fixed-type)
### Get War [GET /wars/{id}] ### Get War [GET /wars/{id}]