Move to OpenAPI for documentation

[deezone]

Due to security issues with the aglio package the API documentation needs to be moved to OpenAPI / Swagger format.

Create documentation in openapi.yaml using OpenAPI Editor for JetBrains (GoLand): https://plugins.jetbrains.com/plugin/12887-openapi-editor/

Add:

"scripts": {
    "generate-api-docs": "node_modules/.bin/redoc-cli bundle docs/openapi.yaml -o docs/api-output.html",
    "docs:watch": "node_modules/.bin/redoc-cli serve docs/openapi.yaml -w",
   ...
}

References:

• How to use npx: the npm package runner

# Before
$ node ./node_modules/.bin/mocha

# Now with npx:
$ npx mocha

• redoc-cli