feat: add openapi docs generation to api

.gitlab-ci.yml

@@ -53,9 +53,9 @@ pages:
   stage: deploy
   script:
     - npm run documentation
-    - mv docs public
+    - mv docs/openapi public
   only:
-    - /^v[0-9]+\.[0-9]+\.[0-9]+$/
+    - master
   artifacts:
     paths:
       - public

package.json

@@ -19,7 +19,7 @@
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md && git commit -m 'docs: update changelog'",
     "check-configuration": "openstapps-configuration",
     "compile": "rimraf lib && tsc && prepend lib/cli.js '#!/usr/bin/env node\n'",
-    "documentation": "node ./node_modules/@openstapps/core-tools/lib/cli.js routes ./node_modules/@openstapps/core/lib ./ROUTES.md && typedoc --includeDeclarations --excludeExternals --mode modules --out docs --readme README.md --listInvalidSymbolLinks src",
+    "documentation": "typedoc --includeDeclarations --excludeExternals --mode modules --out docs --readme README.md --listInvalidSymbolLinks src && openstapps-core-tools openapi ./node_modules/@openstapps/core/lib ./docs/openapi && redoc-cli bundle docs/openapi/openapi.json -o docs/openapi/index.html",
     "postversion": "npm run changelog",
     "prepublishOnly": "npm ci && npm run build",
     "preversion": "npm run prepublishOnly",
@@ -85,6 +85,7 @@
     "mocked-env": "1.3.5",
     "nyc": "15.1.0",
     "prepend-file-cli": "1.0.6",
+    "redoc-cli": "0.12.2",
     "rimraf": "3.0.2",
     "sinon": "10.0.0",
     "sinon-express-mock": "2.2.1",