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

docs(openapi-react-query): fix useMutation API reference #1989

Merged

Conversation

ElayGelbart
Copy link
Contributor

Changes

Fixes incorrect API reference for useMutation in openapi-react-query docs

  • Updates the example to correctly show useMutation instead of useQuery
  • Removes incorrect options parameter that wasn't part of the API

How to Review

The useMutation API reference in docs/openapi-react-query/use-mutation.md now correctly reflects the actual API signature

Checklist

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

I've been using this package extensively in my projects and found it incredibly helpful for maintaining type-safe API clients. The React Query integration makes API state management a breeze. Happy to contribute back to this awesome tool!

@ElayGelbart ElayGelbart requested a review from a team as a code owner November 6, 2024 15:06
Copy link

changeset-bot bot commented Nov 6, 2024

⚠️ No Changeset found

Latest commit: 7d6a147

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@kerwanp kerwanp left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks! Can you please fix the conflict so we can merge this

@kerwanp kerwanp merged commit 626f490 into openapi-ts:main Nov 6, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants