Merged
Conversation
dbanty
approved these changes
Mar 3, 2025
micha91
pushed a commit
to micha91/openapi-python-client
that referenced
this pull request
May 13, 2025
> [!IMPORTANT] > Merging this pull request will create this release ## Breaking Changes ### Support `$ref` in responses Previously, using a `$ref` to define a response was ignored, the code to call the endpoint was still generated, but the response would not be parsed. Now, responses defined with `$ref` will be used to generate the response model, which will parse the response at runtime. If a `$ref` is incorrect or uses a feature that is not supported by the generator, these endpoints will start failing to generate. ## Features ### Make `config` available in custom templates The configuration options object is now exposed as a variable called `config` in Jinja2 templates. ### Add `docstrings_on_attributes` config setting Setting this option to `true` changes the docstring behavior in model classes: for any attribute that have a non-empty `description`, instead of describing the attribute as part of the class's docstring, the description will appear in an individual docstring for that attribute. Co-authored-by: knope-bot[bot] <152252888+knope-bot[bot]@users.noreply.github.com>
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
1 participant
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.
Important
Merging this pull request will create this release
Breaking Changes
Support
$refin responsesPreviously, using a
$refto define a response was ignored, the code to call the endpoint was still generated, butthe response would not be parsed. Now, responses defined with
$refwill be used to generate the response model, whichwill parse the response at runtime.
If a
$refis incorrect or uses a feature that is not supported by the generator, these endpoints will start failing togenerate.
Features
Make
configavailable in custom templatesThe configuration options object is now exposed as a variable called
configin Jinja2 templates.Add
docstrings_on_attributesconfig settingSetting this option to
truechanges the docstring behavior in model classes: for any attribute that have a non-emptydescription, instead of describing the attribute as part of the class's docstring, the description will appear in an individual docstring for that attribute.