Avoid adding undefined to the index signature for additionalProperties #1295
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
🦋 Changeset detectedLatest commit: c55a396 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
pvanagtmaal
force-pushed
the
feat/avoid-undefined-on-additional-properties
branch
from
9169509
to
c55a396
Compare
|
This is great—thank you! I admit I was wrong on this original decision, and this is a better path forward for this library. I do agree that a minor version is best—this is more than a patch change. But I don’t think it would technically be a breaking change and it doesn’t feel right for a major version. |
drwpow
reviewed
Aug 14, 2023
| }`); | ||
| }); | ||
|
|
||
| test("additionalProperties with partly required properties", () => { |
drwpow
approved these changes
Aug 14, 2023
Merged
|
Released in |
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.
Changes
Fixes #1267 and #1018
How to Review
A slightly tricky part about this is that we need to account for objects with not all properties required. In that case, we still need to add undefined to the index signature to avoid TypeScript errors
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)