fix(openapi-fetch): reject excess request body and params properties #2679
Draft
F3n67u wants to merge 1 commit intoopenapi-ts:mainfrom
Draft
fix(openapi-fetch): reject excess request body and params properties #2679F3n67u wants to merge 1 commit intoopenapi-ts:mainfrom
F3n67u wants to merge 1 commit intoopenapi-ts:mainfrom
Conversation
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
🦋 Changeset detectedLatest commit: fd3bdb6 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 |
63eaec9 to
8898518
Compare
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
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 #1769 in
openapi-fetch.This changes
openapi-fetch's request typing so excess properties are rejected consistently forbodyandparams, while preservingparseAsinference. It also moves the new regression coverage into dedicated*.test-d.tstype tests and adds the missing query array params to the sharedcommon.yamlfixture used byparamstests.How to Review
Review
packages/openapi-fetch/src/index.d.tsfirst to verify theparseAstyping now flows through a dedicated generic instead of the full inferredInitobject.Then review the new type tests:
packages/openapi-fetch/test/http-methods/post.test-d.tspackages/openapi-fetch/test/http-methods/request.test-d.tspackages/openapi-fetch/test/path-based-client/path-based-client.test-d.tspackages/openapi-fetch/test/common/params.test-d.tsChecklist
docs/updated (not needed)pnpm run update:examplesrun (not applicable)