feat(backend): improve status and error contract consistency#406
Open
SaitejaKommi wants to merge 1 commit intoopenfoodfacts:mainfrom
Open
feat(backend): improve status and error contract consistency#406SaitejaKommi wants to merge 1 commit intoopenfoodfacts:mainfrom
SaitejaKommi wants to merge 1 commit intoopenfoodfacts:mainfrom
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR standardizes backend error handling so malformed or invalid client queries return predictable HTTP responses instead of generic
500 Internal Server Errorresults.It aligns runtime status mapping, structured error payloads, and OpenAPI documentation to provide a clearer and more reliable contract for API consumers.
Related Issue
Fixes #405
What Changed
Enhanced Error Response Schema
Updated
SearchResponseError/ErrorSearchResponseto include:This enables payload-level status semantics alongside HTTP responses.
Refined Status Mapping Logic
Improved
status_for_responsebehavior inapi.pyto:500only for unspecified/unexpected failuresImproved Validation Error Handling
Wrapped query validation exceptions such as
QueryCheckErrorinto structured client errors returning:400 Bad RequestThis prevents malformed queries from surfacing as server faults.
OpenAPI Contract Improvements
Added explicit route response mappings such as:
to FastAPI decorators for documented success/error contracts.
Affected Files
api.pysearch.pyTesting
Verification gateway executed successfully:
Notes
This is a backend API contract improvement focused on better HTTP semantics, stronger documentation, and safer client-facing error handling.