-
-
Notifications
You must be signed in to change notification settings - Fork 387
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
docs: Improved descriptions and schema adjustments for API references #10976
Conversation
… the generation of fields in the style 1: 2:
…nd to allow the generation of fields in the style 1: 2:
…gi/openfoodfacts-server into fix_apidoc_product_images
…r fields declared as ["key: xx"]: something
…r fields declared as ["key: xx"]: something
…gi/openfoodfacts-server into fix_apidoc_product_images
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
Thank you @shinjigi ! I added a couple of suggestions. |
Co-authored-by: Stéphane Gigandet <[email protected]>
Quality Gate passedIssues Measures |
What
This pull request updates the API reference documentation files (docs/api/ref/schemas/**/*.yaml) to:
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