Add option to handle parameters with default as non-optional #2528
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
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
🦋 Changeset detectedLatest commit: 5d314f4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
if respective option is set
luqasn
force-pushed
the
optional-param-with-default
branch
from
7eb397e to
3f0607e
Compare
Author
|
Test failure seems unrelated, docly have refactored their tests and moved a bunch of files: Redocly/redocly-cli@cf26d60#diff-819418d7530fd6a1220968de72601d679939eb5a01c3b9cc9e388050bd58ff77 |
luqasn
force-pushed
the
optional-param-with-default
branch
from
f3dcc2e to
0f11d02
Compare
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.
Changes
This PR introduces a new option that makes it possible to request that non-required parameters still be generated as non-optional (no question token) if they have a default value set in their schema.
This allows to generate types for certain server implementation use where the default value is injected automatically for the handling function to consume (I am working on one atm) and the signature on the handler should indicate that the value can not be undefined.
This makes it so that the default value can be derived and set by the framework from the openapi spec and does not need to be repeated by the person implementing the operation.
Fixes #2319
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)