Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish JSON schemas separately in documentation #7865

Open
alexgarel opened this issue Dec 20, 2022 · 1 comment
Open

Publish JSON schemas separately in documentation #7865

alexgarel opened this issue Dec 20, 2022 · 1 comment
Labels
📚 Documentation Documentation issues improve the project for everyone. OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. ✅ Task

Comments

@alexgarel
Copy link
Member

alexgarel commented Dec 20, 2022

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

@alexgarel alexgarel added ✅ Task 📚 Documentation Documentation issues improve the project for everyone. labels Dec 20, 2022
@teolemon teolemon changed the title publish json schemas separately in documentation Publish json schemas separately in documentation Dec 21, 2022
@teolemon teolemon changed the title Publish json schemas separately in documentation Publish JSON schemas separately in documentation Dec 21, 2022
@teolemon teolemon added the OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. label Dec 21, 2022
@github-actions
Copy link
Contributor

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

@github-actions github-actions bot added the ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. label Mar 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 Documentation Documentation issues improve the project for everyone. OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. ✅ Task
Projects
Status: To discuss and validate
Status: Todo
Development

No branches or pull requests

2 participants