Fix and improve APIB docs and API tests (CC-82)
parent
9de759805a
commit
1f176e0256
|
@ -5,10 +5,13 @@ Update an army members signature image
|
||||||
**Permission: 4**
|
**Permission: 4**
|
||||||
|
|
||||||
+ Parameters
|
+ Parameters
|
||||||
|
|
||||||
+ userId: `5ab68d42f547ed304064e5f7` (string, required) - army members unique user id
|
+ userId: `5ab68d42f547ed304064e5f7` (string, required) - army members unique user id
|
||||||
|
|
||||||
+ Request (application/json)
|
+ Request (application/json)
|
||||||
{}
|
|
||||||
|
+ Attributes (object)
|
||||||
|
|
||||||
|
|
||||||
+ Response 200 (application/json; charset=utf-8)
|
+ Response 200 (application/json; charset=utf-8)
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,9 @@
|
||||||
### List Users [GET /users{?q,fractFilter,limit,offset}]
|
### List Users [GET /users{?q,fractFilter,squadId,decorationId,limit,offset}]
|
||||||
|
|
||||||
Get single army member information
|
Get single army member information
|
||||||
|
|
||||||
+ Parameters
|
+ Parameters
|
||||||
|
|
||||||
+ q: `hardi` (string, optional) - filter string which filters for partial username
|
+ q: `hardi` (string, optional) - filter string which filters for partial username
|
||||||
|
|
||||||
+ fractFilter: `BLUFOR` (enum[string], optional) - Field to filter by fraction
|
+ fractFilter: `BLUFOR` (enum[string], optional) - Field to filter by fraction
|
||||||
|
@ -12,17 +13,15 @@ Get single army member information
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
+ `GLOBAL`
|
+ `GLOBAL`
|
||||||
|
|
||||||
+ squadId: `591470249e9fae286e008e31` (string, optional) - Field to filter by membership of certain squad
|
+ squadId: `5aba54eaeadcce6332c6a774` (string, optional) - Field to filter by membership of certain squad
|
||||||
|
|
||||||
+ decorationId: `5abd3dff6e6a0334d95b8ba0` (string, optional) - Field to filter by ownership of certain decoration
|
+ decorationId: `5abd3dff6e6a0334d95b8ba0` (string, optional) - Field to filter by ownership of certain decoration
|
||||||
|
|
||||||
+ limit: 20 (number, optional)
|
+ limit: 20 (number, optional) - Maximum number of users to return
|
||||||
Maximum number of users to return
|
|
||||||
|
|
||||||
+ Default: Infinity
|
+ Default: Infinity
|
||||||
|
|
||||||
+ offset: 0 (number, optional)
|
+ offset: 0 (number, optional) - Offset into result-set (useful for pagination)
|
||||||
Offset into result-set (useful for pagination)
|
|
||||||
|
|
||||||
+ Default: 0
|
+ Default: 0
|
||||||
|
|
||||||
|
@ -40,6 +39,7 @@ Get single army member information
|
||||||
Get single army member information
|
Get single army member information
|
||||||
|
|
||||||
+ Parameters
|
+ Parameters
|
||||||
|
|
||||||
+ id: `5ab68d42f547ed304064e5f7` (string, required) - unique id of army-member
|
+ id: `5ab68d42f547ed304064e5f7` (string, required) - unique id of army-member
|
||||||
|
|
||||||
+ Response 200 (application/json; charset=utf-8)
|
+ Response 200 (application/json; charset=utf-8)
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
# Campaign (object)
|
# Campaign (object)
|
||||||
|
|
||||||
Campaign entity
|
Campaign entity
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
@ -9,8 +10,10 @@ Campaign entity
|
||||||
+ __v: 0 (number, required) - version number
|
+ __v: 0 (number, required) - version number
|
||||||
|
|
||||||
#WarCampaign (object)
|
#WarCampaign (object)
|
||||||
|
|
||||||
Cmpaign entity with attached War collection
|
Cmpaign entity with attached War collection
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
+ _id: `5abd55ea9e30a76bfef747d6` (string, required) - unique id of the campaign
|
+ _id: `5abd55ea9e30a76bfef747d6` (string, required) - unique id of the campaign
|
||||||
+ title: `Ein Kessel Buntes` (string, required) - display title of the campaign
|
+ title: `Ein Kessel Buntes` (string, required) - display title of the campaign
|
||||||
+ wars (array[WarWithPlayers], requied)
|
+ wars: WarWithPlayers (array[WarWithPlayers], required)
|
||||||
|
|
|
@ -16,56 +16,66 @@ FORMAT: 1A
|
||||||
|
|
||||||
# Group Access
|
# Group Access
|
||||||
|
|
||||||
|
## Endpoints [/auth]
|
||||||
|
|
||||||
:[Gists](auth/signup.apib)
|
:[Gists](auth/signup.apib)
|
||||||
|
|
||||||
:[Gists](auth/login.apib)
|
:[Gists](auth/login.apib)
|
||||||
|
|
||||||
# Group Admin
|
# Group Admin
|
||||||
|
|
||||||
|
## Account [/account]
|
||||||
|
|
||||||
:[Gists](admin/account.apib)
|
:[Gists](admin/account.apib)
|
||||||
|
|
||||||
|
## Commands [/cmd]
|
||||||
|
|
||||||
:[Gists](admin/signature.apib)
|
:[Gists](admin/signature.apib)
|
||||||
|
|
||||||
# Group Army Overview
|
# Group Army Management
|
||||||
|
|
||||||
|
## Army [/overview]
|
||||||
|
|
||||||
:[Gists](army-management/army.apib)
|
:[Gists](army-management/army.apib)
|
||||||
|
|
||||||
# Group Awardings
|
## Awardings [/awarding]
|
||||||
|
|
||||||
:[Gists](army-management/awardings.apib)
|
:[Gists](army-management/awardings.apib)
|
||||||
|
|
||||||
# Group Campaigns
|
## Decorations [/decorations]
|
||||||
|
|
||||||
:[Gists](statistics/campaigns.apib)
|
|
||||||
|
|
||||||
# Group Decorations
|
|
||||||
|
|
||||||
:[Gists](army-management/decorations.apib)
|
:[Gists](army-management/decorations.apib)
|
||||||
|
|
||||||
# Group Logs
|
## Promotion [/promotions]
|
||||||
|
|
||||||
:[Gists](statistics/logs.apib)
|
|
||||||
|
|
||||||
# Group Players
|
|
||||||
|
|
||||||
:[Gists](statistics/players.apib)
|
|
||||||
|
|
||||||
# Group Promotion
|
|
||||||
|
|
||||||
:[Gists](army-management/promotions.apib)
|
:[Gists](army-management/promotions.apib)
|
||||||
|
|
||||||
# Group Ranks
|
## Ranks [/ranks]
|
||||||
|
|
||||||
:[Gists](army-management/ranks.apib)
|
:[Gists](army-management/ranks.apib)
|
||||||
|
|
||||||
# Group Squads
|
## Squads [/squads]
|
||||||
|
|
||||||
:[Gists](army-management/squads.apib)
|
:[Gists](army-management/squads.apib)
|
||||||
|
|
||||||
# Group Users
|
## Users [/user]
|
||||||
|
|
||||||
:[Gists](army-management/users.apib)
|
:[Gists](army-management/users.apib)
|
||||||
|
|
||||||
# Group Wars
|
# Group Statistics
|
||||||
|
|
||||||
|
## Campaigns [/campaigns]
|
||||||
|
|
||||||
|
:[Gists](statistics/campaigns.apib)
|
||||||
|
|
||||||
|
## Logs [/logs]
|
||||||
|
|
||||||
|
:[Gists](statistics/logs.apib)
|
||||||
|
|
||||||
|
## Players [/players]
|
||||||
|
|
||||||
|
:[Gists](statistics/players.apib)
|
||||||
|
|
||||||
|
## Wars [/wars]
|
||||||
|
|
||||||
:[Gists](statistics/wars.apib)
|
:[Gists](statistics/wars.apib)
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue