Fix issue where complex setups like the testing application cause API docs to break down #59
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
added 6 commits
March 1, 2025 18:35
…th sources are the same
…each registered flask route can be associated with its function declaration
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.
🛠 Changes being made
Give examples of the changes you've made in this pull request. Include an itemized list if you can.
parameter_validation.fn_list, store this value in the properties of the route function - this ensures that routes generated in functions, where the route's function signature would otherwise be non-unique, are able to be associated with their correct documentation, no matter how many times they are registered with different parametersdict_blueprint🧠 Rationale behind the change
Why did you choose to make these changes?
I wanted to ensure that the API documentation is reliable, even in unusual application configurations (like the testing app), as well as make the API documentation testable
Does this pull request resolve any open issues?
Closes #57
Closes #55
Were there any trade-offs you had to consider?
No
🧪 Testing
[ X ] Have tests been added or updated for the changes introduced in this pull request?
[ X ] Are the changes backwards compatible?
If the changes aren't backwards compatible, what other options were explored?
✨ Quality check
[ X ] Are your changes free of any erroneous print statements, debuggers or other leftover code?
[ X ] Has the README been updated to reflect the changes introduced (if applicable)?
💬 Additional comments