Include class docstrings as description in OpenAPI schema#52
Merged
drhagen merged 2 commits intoApr 8, 2026
Conversation
Owner
|
I moved the automatic |
Contributor
Author
That's way better, thanks! And I confirmed it works fine too. |
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.
Class docstrings were not showing up as "description" in the OpenAPI schema. This is because Pydantic v2 delegates schema generation entirely to
__get_pydantic_json_schema__, which we override, and we weren't injectingcls.__doc__into the result.