Generate API documents according to query configuration

[Mini256]

Generate API documents according to the Query definition file to display on the website.

• [x] Add initial docs template: https://ossinsight.io/docs/
• [x] Add a parameter like public: boolean to control whether the query is provided for external use as an exposed API (#834)
• [x] Add description fields to the query definition to add text description for API (#834)
• [ ] Write a script to generate MDX document
• [x] Support defines API as legacy (Better to have) (#855)
• [x] Support multiple-level query definition file (Better to have) (#861)

[sykp241095]

Next, open collections api

[634750802]

Could use OpenAPI as internal document:

params.json -> OpenAPI.json -> swagger ui

[sykp241095]

How about docusaurus-plugin-openapi - Docusaurus OpenAPI, this requires docusaurus-v2: (we are currently using v2-beta.14)

https://www.npmjs.com/package/docusaurus-plugin-openapi

in fact, there actually are some exciting features like “breadcrumb navigation”:

[Mini256]

it sounds nice

[sykp241095]

[634750802]

We could preview docs at https://redocly.github.io/redoc/?url=https://api.ossinsight.io/openapi.yaml

[sykp241095]

@Mini256 Now docusaurus is v2.0, how about trying https://github.com/cloud-annotations/docusaurus-openapi