Skip to content

Fix discriminator propertyName inference #1342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 13, 2023
Merged

Fix discriminator propertyName inference #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1480138
Fix discriminator propertyName inference
drwpow Sep 13, 2023
19d5088
Update docs
drwpow Sep 13, 2023
8169953
Improve tests, fix additional bugs
drwpow Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/friendly-numbers-tease.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"openapi-typescript": patch
---

Fix discriminator propertyName inference
2 changes: 2 additions & 0 deletions docs/src/content/docs/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,4 +488,6 @@ Pet: components["schemas"]["Cat"] | components["schemas"]["Dog"] | components["s
Cat: { type?: "cat"; } & components["schemas"]["PetCommonProperties"];
```

_Note: you optionally could provide `discriminator.propertyName: "type"` on `Pet` ([docs](https://spec.openapis.org/oas/v3.1.0#discriminator-object)) to automatically generate the `type` key, but is less explicit._

While the schema permits you to use composition in any way you like, it’s good to always take a look at the generated types and see if there’s a simpler way to express your unions & intersections. Limiting the use of `oneOf` is not the only way to do that, but often yields the greatest benefits.
2,288 changes: 1,566 additions & 722 deletions packages/openapi-typescript/examples/github-api-next.ts
View file
Open in desktop

Large diffs are not rendered by default.

Loading