Refactor error handling to use Problem Details format across API responses - #6
Merged
Merged
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.
Closes #5
This pull request refactors the API error handling to fully adopt the RFC 9457 "problem+json" standard for error responses, improving consistency and machine-readability. It introduces a new
ProblemDetailschema, updates all error handlers and OpenAPI docs to use this format, and adjusts tests and endpoints accordingly. Additionally, it adds a Makefile help target and improves documentation for developer workflows.API error handling improvements:
ProblemDetailmodel andproblem_responsehelper inapp/api/errors.pyto standardize all error responses asapplication/problem+jsonper RFC 9457.titlefield and mapped them to appropriate HTTP status codes and error URIs. [1] [2]/readyz,/synthesize,/voices) to return problem+json responses and updated OpenAPI documentation to reference the new schema. [1] [2] [3] [4] [5] [6] [7]errorsfield.Test updates:
Developer workflow improvements:
helptarget to theMakefileas the default goal, and added/updated descriptions for all targets to improve developer experience.