Add GET ranks to apib

pull/32/head
Florian Hartwich 2018-03-29 17:13:55 +02:00
parent eaff8b4ea9
commit f8db29408f
6 changed files with 39 additions and 2 deletions

View File

@ -19,7 +19,6 @@ List all promotion requests
+ `OPFOR`
+ `GLOBAL`
+ Response 200
+ Attributes (array[Promotion])

View File

@ -0,0 +1,18 @@
### GET Ranks [GET /ranks{?q,fractFilter}]
List all ranks
+ Parameters
+ q: `Gefr` (string, optional) - filter string which filters for partial username
+ fractFilter (enum[string], optional)
Field to filter by fraction
+ Members
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
+ Response 200
+ Attributes (array[Rank])

View File

@ -0,0 +1,16 @@
# Rank (object)
A rank that can be applied to army members by level/fraction
## Properties
+ _id: `591469c9ef4a6810623ed4ea` (string, required) - the unique id of the rank
+ name: `Gefreiter` - display name of the rank
+ fraction: `BLUFOR` - enum expressing the fraction in which the decoration is given
+ Members
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
+ level: 1 - rank level
+ updatedAt: `2017-09-20T20:25:29.995Z` (string, required) - the version timestamp
+ timestamp: `2017-05-11T13:40:25.051Z` - the creation timestamp
+ __v: 1 - version number

View File

@ -12,6 +12,8 @@
:[Gists](_promotion.apib)
:[Gists](_rank.apib)
:[Gists](_squad.apib)
:[Gists](_user.apib)

View File

@ -42,6 +42,8 @@ FORMAT: 1A
# Group Ranks
:[Gists](army-management/ranks.apib)
# Group Requests
:[Gists](army-management/promotions.apib)

View File

@ -23,7 +23,7 @@ export class AppComponent implements OnInit {
scrollBtnVisibleVal = 100;
version = 'v' + require('./../../../package.json').version;
version = 'v'.concat(require('./../../../package.json').version);
constructor(public loginService: LoginService,
private promotionService: PromotionService,