typing(web): unify JSONResponse return in context route handlers#190
Merged
typing(web): unify JSONResponse return in context route handlers#190
Conversation
Change 5 handlers from -> dict to -> JSONResponse and wrap success-path dicts in JSONResponse(content=...). Error paths already returned JSONResponse (409 mtime conflict / 422 parse error), so this unifies the return type without changing response bodies.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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
`update_command`, `rendered_agent`, `update_agent`) from
`-> dict` to `-> JSONResponse`.
422 parse error), so this unifies the return type.
Option 2 from the issue: uniform `JSONResponse` is more accurate
and self-documenting than a union type, and avoids pushing narrowing
burden to callers. Response bodies are byte-for-byte equivalent —
FastAPI serialises `dict` and `JSONResponse(content=dict)` identically.
Closes #112