fix(type-safe-api): generate models for inline request body schemas #873
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
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 1df132d. 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. |
Inline request body schemas were typed as `any` and no model was generated for them. Address this by hoisting inline request schemas in the same way we do for responses. Note that OpenAPI generator named these hoisted inline request models `<OperationID>Request` which also clashes with the overall operation request model - and resolved it by appending `Operation` to the Operation ID (see #789). We deviate from OpenAPI generator behaviour to avoid this issue recurring by naming the type `<OperationID>RequestContent`.
cogwirrel
force-pushed
the
fix/inline-request-bodies
branch
from
e57d1cc
to
1df132d
Compare
agdimech
approved these changes
Oct 25, 2024
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.
Inline request body schemas were typed as
anyand no model was generated for them.Address this by hoisting inline request schemas in the same way we do for responses.
Note that OpenAPI generator named these hoisted inline request models
<OperationID>Requestwhichalso clashes with the overall operation request model - and resolved it by appending
Operationtothe Operation ID (see #789).
We deviate from OpenAPI generator behaviour to avoid this issue recurring by naming the type
<OperationID>RequestContent.