OpenAPI specification for the TerminusDB API

[rrooij]

I wrote a OpenAPI specification file for the TerminusDB API but I have no clue where I should put it.

You can view the API specification easily by loading the attached yaml into: https://editor.swagger.io/

https://gist.github.com/rrooij/6a5f44ffa2ea7417fa0987b2529481e3

We are trying GitBook and GitBook supports OpenAPI specs as well for easy documentation generation: https://docs.gitbook.com/features/openapi

[rrooij]

Temporary repo: https://github.com/terminusdb-labs/openapi-spec

[spl]

The GitBook documentation says that we can provide the OpenAPI file in one of two ways:

• Upload your OpenAPI formatted file, or
• Provide a URL to your publicly available OpenAPI file.

Since we can provide a link, I'm inclined to keep OpenAPI files in a separate repository for better visibility and process documentation. The current link would be https://raw.githubusercontent.com/terminusdb-labs/openapi-spec/main/openapi.yaml, but I would suggest moving the repo to terminusdb/openapi-specs since we may well be adding more.

[spl]

The new repository is https://github.com/terminusdb/openapi-specs.