Compare commits

..

No commits in common. "a24f3bf4b12566bfa62be974aea917178fa7ead6" and "a994f419e7c42f85d68da8891c3af365d57ec9be" have entirely different histories.

15 changed files with 35 additions and 94 deletions

View File

@ -2,8 +2,6 @@
List all app users, ordered by username
**Permission: 4**
+ Response 200 (application/json; charset=utf-8)
+ Attributes (array[AppUser], fixed-type)
@ -13,8 +11,6 @@ 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
@ -29,8 +25,6 @@ Update an app user, identified by its id
### Delete App User [DELETE /account/{id}]
**Permission: 4**
Delete an app user
+ Parameters

View File

@ -2,8 +2,6 @@
Update an army members signature image
**Permission: 4**
+ Parameters
+ userId: `5ab68d42f547ed304064e5f7` (string, required) - army members unique user id

View File

@ -28,7 +28,7 @@ List all awardings
Create a new awarding which is immediatly assigned to the user
**Permission: 2**
*Permission: 2*
+ Request (application/json)
@ -46,7 +46,7 @@ Create a new awarding which is immediatly assigned to the user
Create a new awarding proposal, that needs to be approved by higher permission level user to take effect
**Permission: 1**
*Permission: 1*
+ Request (application/json)

View File

@ -34,8 +34,6 @@ Retrieve single decoration data
Create a new decoration
**Permission: 2**
+ Request (multipart/form-data; boundary=---BOUNDARY)
-----BOUNDARY
@ -75,8 +73,6 @@ Create a new decoration
Update decoration, identified by its id
**Permission: 2**
+ Parameters
+ id: `5abeb420b987672bb1ede643` (string, required) - unique id of the decoration
@ -119,8 +115,6 @@ Update decoration, identified by its id
Delete a decoration
**Permission: 2**
+ Parameters
+ id: `5abeb43cb987672bb1ede644` (string, required) - unique id of the decoration

View File

@ -27,7 +27,7 @@ List all promotion requests
Create a new proposal for a promotion, that needs to be approved by higher permission level user to take effect
**Permission: 1**
*Permission: 1*
+ Request (application/json)
@ -45,7 +45,7 @@ Create a new proposal for a promotion, that needs to be approved by higher permi
Update the promotion proposal
**Permission: 2**
*Permission: 2*
+ Parameters
+ id: `5abf50d9861d950f157c4a0a` (string, required) - unique id of the promotion

View File

@ -33,8 +33,6 @@ Retrieve single rank data
Create a new rank
**Permission: 2**
+ Request (multipart/form-data; boundary=---BOUNDARY)
-----BOUNDARY
@ -69,8 +67,6 @@ Create a new rank
Update rank, identified by its id
**Permission: 2**
+ Parameters
+ id: `5abeb23995cf43205225710b` (string, required) - unique id of the rank
@ -108,8 +104,6 @@ Update rank, identified by its id
Delete a rank
**Permission: 2**
+ Parameters
+ id: `5abeb1b995cf43205225710a` (string, required) - unique id of the rank

View File

@ -32,8 +32,6 @@ Get single squad information
Create a new squad
**Permission: 2**
+ Request (multipart/form-data; boundary=---BOUNDARY)
-----BOUNDARY
@ -63,8 +61,6 @@ Create a new squad
Update squad, identified by its id
**Permission: 2**
+ Parameters
+ id: `5abe166f8b7488392a623f12` (string, required) - unique id of the squad
@ -102,8 +98,6 @@ Update squad, identified by its id
Delete a squad
**Permission: 2**
+ Parameters
+ id: `5abe16f98b7488392a623f17` (string, required) - unique id of the squad

View File

@ -48,8 +48,6 @@ Get single army member information
Create a new army member
**Permission: 2**
+ Request (application/json)
+ Attributes
@ -63,8 +61,6 @@ 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
@ -85,8 +81,6 @@ Update an army member, identified by its id
Delete an army member
**Permission: 2**
+ Parameters
+ id: `5abd4780396bc0487068be0e` (string, required) - unique id of army-member

View File

@ -33,23 +33,3 @@ The following example illustrates how to provide the token when using `curl`
> curl -H "X-Access-Token: $CC_API_TOKEN" <API_RESOURCE_PATH_GOES_HERE>
```
## Permission Levels
The permission level is resolved by the API token you send, which resolves the specific app user information.
Endpoints that require a certain permission level to be accessed, mention the **minimum** required permission level in the description.
::: note
Permission Levels:
0 - User
1 - Squadlead
2 - High Command
3 - Maintainer
4 - Administrator
:::

View File

@ -12,9 +12,9 @@ An app user instance with populated squad
## Properties
+ activated: true (boolean, required) - account activation status
+ password: `$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4` (string, required) - password hash value
+ password: "$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4" (string, required) - password hash value
+ permission: 1 (number, required) - permission level
+ secret: `I like tacos` (string, required) - secret used for account activation comparison
+ secret: "I like tacos" (string, required) - secret used for account activation comparison
+ squad (Squad, required, nullable) - squad the app user is responsible for
+ timestamp: `2017-08-02T07:48:56.378Z` (string, required) - creation timestamp
+ updatedAt: `2017-08-02T08:07:20.929Z` (string, required) - version timestamp
@ -25,7 +25,7 @@ An app user instance for PATCH updating
## Properties
+ activated: true (boolean, optional) - account activation status
+ password: `$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4` (string, optional) - password hash value
+ password: "$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4" (string, optional) - password hash value
+ permission: 1 (number, optional) - permission level
+ secret: `I like tacos` (string, optional) - secret used for account activation comparison
+ secret: "I like tacos" (string, optional) - secret used for account activation comparison
+ squad: `5abe166f8b7488392a623f12` (string, optional) - id of squad the app user is responsible for

View File

@ -7,9 +7,9 @@
# LogPoints (Log)
## Properties
+ ptBlufor: 2 (number, required) - standings for BLUFOR
+ ptOpfor: 4 (number, required) - standings for OPFOR
+ fraction: `OPFOR` (enum, required) - dominating fraction
+ ptBlufor: 2 (number, required) -
+ ptOpfor: 4 (number, required) -
+ fraction: `OPFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`
@ -17,28 +17,28 @@
#LogBudget (Log)
## Properties
+ oldBudget: 400000 (number, required) - budget before buy action
+ newBudget: 380000 (number, required) - budget after buy action
+ fraction: `BLUFOR` (enum, required) - buying fraction
+ oldBudget: 400000 (number, required)
+ newBudget: 380000 (number, required)
+ fraction: `BLUFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`
#LogFlag (Log)
## Properties
+ player: `HardiReady` (string, required) - name of player who captured/secured flag
+ capture: true (boolean, required) - true if flag was captured, false if it was secured
+ flagFraction: `BLUFOR` (enum, required) - fraction who owns the flag
+ player: `HardiReady` (string, required)
+ capture: true (boolean, required)
+ flagFraction: `BLUFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`
#LogKill (Log)
## Properties
+ shooter: `HardiReady` (string, required) - name of player who made the kill
+ target: `KalleK` (string, required) - name of player which got killed
+ friendlyFire: true (boolean, required) - true if it was a friendly fire kill, false if it was a normal kill
+ fraction: `BLUFOR` (enum, required) - fraction of shooter
+ shooter: `HardiReady` (string, required)
+ target: `KalleK` (string, required)
+ friendlyFire: true (boolean, required)
+ fraction: `BLUFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`
@ -46,33 +46,33 @@
#LogRespawn (Log)
## Properties
+ player: `radical1976` (string, required) - name of the player who respawns
+ player: `radical1976` (string, required)
#LogRevive (Log)
## Properties
+ medic: `radical1976` (string, required) - name of the player who revives/stabilizes
+ patient: `HardiReady` (string, required) - name of the player who is revived/stabilized
+ stabilized: false (boolean, required) - false if it is a revive, true if it is stabilizing
+ fraction: `BLUFOR` (enum, required) - fraction of the medic
+ medic: `radical1976` (string, required)
+ patient: `radical1976` (string, required)
+ stabilized: false (boolean, required)
+ flagFraction: `BLUFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`
#LogTransport (Log)
## Properties
+ driver: `radical1976` (string, required) - name of the vehicle driver/pilot
+ passenger: `radical1976` (string, required) - name of the passenger being transported
+ distance: 2435 (number, required) - distance of transport in meters
+ fraction: `BLUFOR` (enum, required) - fraction of the driver
+ driver: `radical1976` (string, required)
+ passenger: `radical1976` (string, required)
+ distance: 2435 (number, required)
+ flagFraction: `BLUFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`
#LogVehicle (Log)
## Properties
+ shooter: `HardiReady` (string, required) - name of player who shot the vehicle
+ target: `T-100` (string, required) - name of the vehicle
+ fraction: `BLUFOR` (enum, required) - fraction of the shooter
+ shooter: `HardiReady` (string, required)
+ target: `Murda]X[` (string, required)
+ fraction: `BLUFOR` (enum, required)
+ Members
+ `BLUFOR`
+ `OPFOR`

1
api/apib/filename.jpg Normal file
View File

@ -0,0 +1 @@
asddas

View File

@ -13,8 +13,6 @@ Get single campaign information
Create a new campaign
**Permission: 3**
+ Request Create new army member (application/json)
+ Attributes
@ -28,8 +26,6 @@ Create a new campaign
Delete a campaign
**Permission: 3**
+ Parameters
+ id: `5abd58989e30a76bfef747e6` (string, required) - unique id of campaign

View File

@ -22,8 +22,6 @@ 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)
@ -80,8 +78,6 @@ Create a new war
Delete a war
**Permission: 3**
+ Parameters
+ id: `5abf65d83fc5fa349ffd5cbb` (string, required) - unique id of the war

View File

@ -14,7 +14,7 @@
"start-test": "DEBUG='cc:*' NODE_ENV=unitTest node server.js",
"start-api-test": "rm -rf ./apib/dredd/data/tmp-resource && cp -r ./apib/dredd/data/resource ./apib/dredd/data/tmp-resource && DEBUG='cc:*' NODE_ENV=dreddTest node server.js",
"api:compile-docs": "$(npm bin)/hercule apib/dev-doc.apib -o apib/documentation.apib",
"api:publish-docs": "$(npm bin)/aglio --theme-variables streak --theme-full-width -i ./apib/documentation.apib -o ../public/api-docs.html",
"api:publish-docs": "$(npm bin)/aglio --theme-variables slate -i ./apib/documentation.apib -o ../public/api-docs.html",
"api:test-docs": "npm run api:docs && $(npm bin)/dredd",
"api:docs": "npm run api:compile-docs && npm run api:publish-docs"
},