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

clean up api docs

pull/32/head
HardiReady 2018-04-02 10:38:16 +02:00
parent c921afa3fe
commit 4a33b87216
3 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api/apib/base/access.apib
View File

@ -40,11 +40,16 @@ The permission level is resolved by the API token you send, which resolves the s
Endpoints that require a certain permission level to be accessed, mention the **minimum** required permission level in the description. Endpoints that require a certain permission level to be accessed, mention the **minimum** required permission level in the description.
``` ::: note
Permission Levels: Permission Levels:
0 - User 0 - User
1 - Squadlead 1 - Squadlead
2 - High Command 2 - High Command
3 - Maintainer 3 - Maintainer
4 - Administrator 4 - Administrator
``` :::

8
api/apib/data_structures/_app-user.apib
View File

@ -12,9 +12,9 @@ An app user instance with populated squad
## Properties ## Properties
+ activated: true (boolean, required) - account activation status + 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 + 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 + squad (Squad, required, nullable) - squad the app user is responsible for
+ timestamp: `2017-08-02T07:48:56.378Z` (string, required) - creation timestamp + timestamp: `2017-08-02T07:48:56.378Z` (string, required) - creation timestamp
+ updatedAt: `2017-08-02T08:07:20.929Z` (string, required) - version timestamp + updatedAt: `2017-08-02T08:07:20.929Z` (string, required) - version timestamp
@ -25,7 +25,7 @@ An app user instance for PATCH updating
## Properties ## Properties
+ activated: true (boolean, optional) - account activation status + 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 + 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 + squad: `5abe166f8b7488392a623f12` (string, optional) - id of squad the app user is responsible for

2
api/package.json
View File

@ -14,7 +14,7 @@
"start-test": "DEBUG='cc:*' NODE_ENV=unitTest node server.js", "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", "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:compile-docs": "$(npm bin)/hercule apib/dev-doc.apib -o apib/documentation.apib",
"api:publish-docs": "$(npm bin)/aglio --theme-variables slate --theme-full-width -i ./apib/documentation.apib -o ../public/api-docs.html", "api:publish-docs": "$(npm bin)/aglio --theme-variables streak --theme-full-width -i ./apib/documentation.apib -o ../public/api-docs.html",
"api:test-docs": "npm run api:docs && $(npm bin)/dredd", "api:test-docs": "npm run api:docs && $(npm bin)/dredd",
"api:docs": "npm run api:compile-docs && npm run api:publish-docs" "api:docs": "npm run api:compile-docs && npm run api:publish-docs"
}, },