packages/openapi-react-query: Update createClient documentation#2655
Open
arnitdo wants to merge 1 commit intoopenapi-ts:mainfrom
Open
packages/openapi-react-query: Update createClient documentation#2655arnitdo wants to merge 1 commit intoopenapi-ts:mainfrom
arnitdo wants to merge 1 commit intoopenapi-ts:mainfrom
Conversation
Update createClient documentation in openapi-react-query to point out incompatibility between `@tanstack/react-query`'s `QueryClient` and the generated `OpenapiQueryClient`. The current documentation assumes that the user has constructed a `QueryClient` already, the updated documentation explicitly brings forward the same assumption
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
|
Author
|
Hmm I may have created a PR into the wrong file (packages/../README.md) If the content is correct, I'll edit the PR and change the right files (assuming docs/../index.md) . Did this hastily over the web UI, sorry! |
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
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.
Update createClient documentation in openapi-react-query to point out incompatibility between
@tanstack/react-query'sQueryClientand the generatedOpenapiQueryClient.The current documentation assumes that the user has constructed a
QueryClientalready, the updated documentation explicitly brings forward the same assumptionChanges
Documentation-only
How to Review
Documentation change, explicitly notes the QueryClient assumption made for openapi-react-query's generated OpenpiQueryClient
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript) NOT REQUIRED