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

docs: Improved descriptions and schema adjustments for API references #10976

Merged

Conversation

shinjigi
Copy link
Contributor

@shinjigi shinjigi commented Nov 5, 2024

What

This pull request updates the API reference documentation files (docs/api/ref/schemas/**/*.yaml) to:

  • Improve clarity and detail by adding descriptions and comments to properties and references.
  • Address potential issues related to rapidoc and generator errors.
  • Make adjustments to schema definitions for better accuracy.
  • Added recursive references for Ingredient and Nutrient schemas in api.yml to fix generator errors.
  • Reorganized the structure of the image.yaml, image_role.yaml, image_urls.yaml, nutrients.yaml, product_base.yaml, product_ecoscore.yaml, product_extended.yaml, and product_tags.yaml files for better clarity and maintainability.
  • Updated pattern properties and refactored the structure of these YAML files to ensure consistency and correctness.

We believe these changes will enhance the usability and understanding of the API reference for developers.

Please review the changes and let us know if you have any feedback.

SCREENSHOT

image

@shinjigi shinjigi requested a review from a team as a code owner November 5, 2024 09:02
@github-actions github-actions bot added 📚 Documentation Documentation issues improve the project for everyone. 📚 OpenAPI labels Nov 5, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.03%. Comparing base (dc04d18) to head (649c68a).
Report is 749 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10976      +/-   ##
==========================================
- Coverage   49.54%   49.03%   -0.51%     
==========================================
  Files          67       77      +10     
  Lines       20650    22239    +1589     
  Branches     4980     5316     +336     
==========================================
+ Hits        10231    10906     +675     
- Misses       9131    10000     +869     
- Partials     1288     1333      +45     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stephanegigandet
Copy link
Contributor

Thank you @shinjigi ! I added a couple of suggestions.

Copy link

sonarcloud bot commented Nov 7, 2024

@stephanegigandet stephanegigandet merged commit eeefdf0 into openfoodfacts:main Nov 8, 2024
15 checks passed
@shinjigi shinjigi deleted the fix_apidoc_product_images branch November 8, 2024 17:48
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
Development

Successfully merging this pull request may close these issues.

4 participants