OpenAPI 3.1.0 Documentation Generation #42
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
Closed
smt5541
force-pushed
the
dev/smt5541/openapi
branch
from
61f19e2 to
87d9f4b
Compare
smt5541
changed the title
…re ending with a function name, which could be satisfied incorrectly if one function's name was the end of another function name
Ge0rg3
requested changes
Oct 15, 2024
| return schema | ||
|
|
||
|
|
||
| def generate_openapi_paths_object(): |
There was a problem hiding this comment.
Please can we add some comments/spacing to this function? It is quite tricky to understand the flow atm. Otherwise looks great!
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
🧠 Rationale behind the change
Why did you choose to make these changes?
I wanted the API documentation generated by this library to be in a standard format, and OpenAPI is commonly used, with tools like Swagger for displaying it in a convenient and useful way.
Does this pull request resolve any open issues?
Nope
Were there any trade-offs you had to consider?
Whether to continue supporting the existing documentation format:
It isn't hurting anything, most of its underlying code is needed to support OpenAPI, and has the benefit of being rendered as HTML by a built-in blueprint and template, so I've chosen to leave it in.
Handling JSON Schema of
blacklist/whitelist/patternBecause making a compound regex that properly handles a character blacklist, character whitelist and other custom regex is either impossible or near impossible, the generated OpenAPI Schema will only consider
pattern🧪 Testing
N/A
If the changes aren't backwards compatible, what other options were explored?
✨ Quality check
Are your changes free of any erroneous print statements, debuggers or other leftover code?
Has the README been updated to reflect the changes introduced (if applicable)?
💬 Additional comments
Feel free to add any further information below