fastpi: return error responses formatted for the connectrpc protocol #77
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
Signed-off-by: Achille Roussel <achille.roussel@gmail.com>
Signed-off-by: Achille Roussel <achille.roussel@gmail.com>
Pryz
approved these changes
Feb 20, 2024
achille-roussel
added a commit
to dispatchrun/dispatch-proto
that referenced
this pull request
Feb 20, 2024
This PR documents HTTP status codes used by dispatchrun/dispatch-py#77 and the format of error response payloads.
pelletier
changed the title
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.
This PR changes the FastAPI adapter to return error responses in the format expected by the Connect protocol (see https://connectrpc.com/docs/protocol/#error-end-stream).
All errors will now be reported as a http response with a non-200 status code, and a JSON body with this shape:
{ "code": "...", "message": "..." }Two status codes are now reserved to indicate issues with http request signatures:
ValueErrorraised when the signature uses an unsupported hashing algorithm or when it didn't contain all the expected attributes (these should never occur when connected to the Dispatch platform)