Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop init argument when not needed in query key #2061

Merged
merged 2 commits into from
Jan 25, 2025

Conversation

kevmo314
Copy link
Contributor

Changes

For urls that do not include an init param, generate a query key of length 2. This allows the value to be passed directly to invalidateQueries().

Without this change, the package generates ["get", "/foo", undefined] which does not correctly match the corresponding get query.

Related to #1806

How to Review

This doesn't quite solve the problem when there are init params but at least solves for the case where there are no params...

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@kevmo314 kevmo314 requested a review from a team as a code owner December 20, 2024 03:16
@kevmo314 kevmo314 requested a review from kerwanp December 20, 2024 03:16
Copy link

changeset-bot bot commented Dec 20, 2024

🦋 Changeset detected

Latest commit: 3751ad8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
openapi-react-query Patch

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

For urls that do not include an init param, generate a query key of length 2. This allows the value to be passed directly to `invalidateQueries()`.

Without this change, the package generates `["get", "/foo", undefined]` which does not correctly match the corresponding get query.

Related to openapi-ts#1806
@kerwanp kerwanp added the openapi-react-query Relevant to openapi-react-query label Jan 23, 2025
@kerwanp
Copy link
Contributor

kerwanp commented Jan 23, 2025

Looks good to me ! Could you add a minor changeset?

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great test, thank you! If you could add a patch changeset (see comment) I’d be happy to approve & release

Copy link

netlify bot commented Jan 25, 2025

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 3751ad8

@drwpow drwpow merged commit 6871e73 into openapi-ts:main Jan 25, 2025
8 checks passed
@openapi-ts-bot openapi-ts-bot mentioned this pull request Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
openapi-react-query Relevant to openapi-react-query
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants