Return $metadata resource as odata + openapi spec

Returning odata and openapi specs in json format. Specs are scoped to the request permissions. Different users (roles) will receive different metadata endpoints and resources. Change-type: minor Signed-off-by: Harald Fischer <[email protected]> Signed-off-by: fisehara <[email protected]>
balena-io · Dec 9, 2022 · cf5f0d3 · cf5f0d3
1 parent a8de5fe
commit cf5f0d3
Show file tree

Hide file tree

Showing 11 changed files with 988 additions and 139 deletions.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-14.53.6
+14.53.6
diff --git a/package.json b/package.json
@@ -21,7 +21,13 @@
     "test": "npm run lint & npm run build && npm run webpack-build && npm run test:compose",
     "test:compose": "trap 'docker-compose -f docker-compose.npm-test.yml down ; echo Stopped ; exit 0' SIGINT; docker-compose -f docker-compose.npm-test.yml up -d && sleep 2 && DATABASE_URL=postgres://docker:docker@localhost:5431/postgres npm run mocha",
     "mocha": "TS_NODE_FILES=true mocha",
-    "prettify": "balena-lint -e js -e ts --fix src build typings Gruntfile.ts"
+    "mocha:local": "DATABASE_URL=postgres://docker:docker@localhost:5431/postgres npm run mocha",
+    "compose:postgres": "docker-compose -f docker-compose.test.yml up -d postgres",
+    "compose:build": "docker-compose -f docker-compose.test.yml build",
+    "compose:down": "docker-compose -f docker-compose.test.yml down",
+    "prettify": "balena-lint -e js -e ts --fix src build typings Gruntfile.ts",
+    "serve-openapi": "redoc-cli serve --ssr ./example-openapi.json",
+    "build-openapi": "redoc-cli build ./example-openapi.json"
   },
   "dependencies": {
     "@balena/abstract-sql-compiler": "^7.23.0",
@@ -55,8 +61,9 @@
     "express-session": "^1.17.3",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.15",
-    "pinejs-client-core": "^6.12.2",
-    "randomstring": "^1.2.3",
+    "odata-openapi": "^0.18.1",
+    "pinejs-client-core": "^6.10.2",
+    "randomstring": "^1.2.2",
     "typed-error": "^3.2.1"
   },
   "devDependencies": {
@@ -85,6 +92,7 @@
     "load-grunt-tasks": "^5.1.0",
     "mocha": "^10.1.0",
     "raw-loader": "^4.0.2",
+    "redoc-cli": "^0.13.18",
     "require-npm4-to-publish": "^1.0.0",
     "supertest": "^6.3.3",
     "terser-webpack-plugin": "^5.3.6",