Publish JSON schemas separately in documentation - Githubissues

openfoodfacts / openfoodfacts-server

Open Food Facts database, API server and web interface - 🐪🦋 Perl, CSS and JS coders welcome 😊 For helping in Python, see Robotoff or taxonomy-editor

http://openfoodfacts.github.io/openfoodfacts-server/

GNU Affero General Public License v3.0

656 stars 386 forks source link

Publish JSON schemas separately in documentation #7865

Open alexgarel opened 1 year ago

alexgarel commented 1 year ago

What

We use redoc to render the API documentation. This is cool, but it is a bit hard to see the structure of the data there, and not easy to split in chunks.
We split some of the the JSON schemas in chunks in YAML files, we could leverage it and use a tool to publish only JSON schemas in reference (it would be something complementary to OpenAPI rendering).
See https://json-schema.org/implementations.html#documentation-generators for available tools.

Part of

7446

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 90 days with no activity.