Repository navigation
Document a tested JSON response fallback for unknown URLs - #534
Open
ShahadatTest wants to merge 1 commit into
Open
ShahadatTest wants to merge 1 commit into
ShahadatTest wants to merge 1 commit into
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.
Refs #383.
Document the existing catch-all handler recipe suggested in that discussion for APIs that return JSON from unknown URLs. Register a persistent fallback after specific persistent handlers, and show a known URL returning its own response and a dynamically generated unknown URL returning JSON with status 404.
The documentation explicitly explains that the fallback handles the request, so it will not be reported as unexpected by
check_assertions(). This documents existing functionality; it does not add a custom no-handler response API or change unmatched-request behavior.The how-to uses literalinclude to keep the example synchronized with an executable test. Validation on Windows / CPython 3.12.10 / pytest 9.1.1:
git diff --checkpasses. No production source changes.Prepared with assistance from OpenAI Codex; the agent wrote and executed the example and documentation checks.