fix(type-safe-api): fix named composite models and composite model types #878
Conversation
This file contains 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
Smithy uses the `title` field in OpenAPI to name composite models (all-of, one-of, any-of), which OpenAPI generator also used to produce more readable generated code. This change updates to use the title to name composite models if present for parity with OpenAPI generator. Additionally, nested composite model properties were typed as `any`. Since we know that we always hoist and generate a type for composite models, we use the model name as the type for these.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit d47822c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
agdimech
approved these changes
Oct 30, 2024
cogwirrel
force-pushed
the
fix/one-of-types
branch
from
12f87fb to
d47822c
Compare
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.
Smithy uses the
titlefield in OpenAPI to name composite models (all-of, one-of, any-of), which OpenAPI generator also used to produce more readable generated code. This change updates to use the title to name composite models if present for parity with OpenAPI generator.Additionally, nested composite model properties were typed as
any. Since we know that we always hoist and generate a type for composite models, we use the model name as the type for these.