feat!:Use "Type<Title>" instead of "Type<Index>" if available #962
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
wallagib
force-pushed
the
use-descriptive-type-names
branch
from
7ba5370 to
725c4c8
Compare
wallagib
changed the title
wallagib
force-pushed
the
use-descriptive-type-names
branch
from
725c4c8 to
85350a7
Compare
|
Force-pushed a linting fix |
Changed behavior from using the term `x_type_0` to `x_type_y` if x is a Schema that defines a Title property string `y`. This provides an easier interface for understanding what users are importing, as well as less reliance on the ordering of the schema. BREAKING CHANGE: The name of imports will change if the Schema they were built on previously used Title properties on fields within a oneOf Union.
wallagib
force-pushed
the
use-descriptive-type-names
branch
from
85350a7 to
5c93054
Compare
|
Rebased and expanded usage a bit with #1301. Thanks for the original PR, and sorry for the very long delay! |
dbanty
added a commit
that referenced
this pull request
Aug 17, 2025
Replaces #962 with a rebase & a couple tweaks Co-authored-by: Gibryon Bhojraj <[email protected]>
Closed
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 26, 2025
> [!IMPORTANT]
> Merging this pull request will create this release
## Breaking Changes
### Change some union variant names
When creating a union with `oneOf`, `anyOf`, or a list of `type`, the
name of each variant used to be `type_{index}`
where the index is based on the order of the types in the union.
This made some modules difficult to understand, what is a
`my_type_type_0` after all?
It also meant that reordering union members, while not a breaking change
to the API, _would_ be a breaking change
for generated clients.
Now, if an individual variant has a `title` attribute, that `title` will
be used in the name instead.
This is only an enhancement for documents which use `title` in union
variants, and only a breaking change for
_inline models_ (not `#/components/schemas` which should already have
used more descriptive names).
Thanks @wallagib for PR #962!
## Features
### Support patterned and default HTTP statuses
HTTP statuses like `2XX` and `default` are now supported!
A big thank you to:
- @PSU3D0 for PR #973 (eons ago 😅)
- @obs-gh-peterkolloch for PR #1300
- @goodsonjr for PR #1304
Closes #1271 and #832
> [!NOTE]
> Custom template users: the `endpoint.responses` type has changed quite
a bit. Check out #1303 for the changes.
Co-authored-by: knope-bot[bot] <152252888+knope-bot[bot]@users.noreply.github.com>
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.
Changed behavior from using the term
x_type_0tox_type_yif x is a Schema that defines aTitleproperty stringy.This provides an easier interface for understanding what users are importing, as well as less reliance on the ordering of the schema.