-
-
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
feat: openApi refactor fields parameter to support multiple values with enum validation (getProductByBarCode/search) #11012
Open
shinjigi
wants to merge
12
commits into
openfoodfacts:main
Choose a base branch
from
shinjigi:feat_doc_openapi_product_fields_defined
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+82
−95
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
📚 Documentation
Documentation issues improve the project for everyone.
label
Nov 13, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11012 +/- ##
==========================================
- Coverage 49.54% 49.03% -0.52%
==========================================
Files 67 77 +10
Lines 20650 22243 +1593
Branches 4980 5318 +338
==========================================
+ Hits 10231 10906 +675
- Misses 9131 10003 +872
- Partials 1288 1334 +46 ☔ View full report in Codecov by Sentry. |
…t migrated in nutriscore definition
…hub.com/shinjigi/openfoodfacts-server into feat_doc_openapi_product_fields_defined
Quality Gate passedIssues Measures |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This PR improves the OpenAPI specification for the
fields
parameter in the product and search endpoint.The changes make the API specification more accurate and provide better validation and documentation for the fields parameter, which is critical for controlling response payload size and structure.
Related issue(s) and discussion
Implementation details
parameters/product_available-fields.yaml
to house fields parameter definitionTesting
Note: This change is purely to the API specification and does not affect the actual API implementation.