docs: add-missing-docs#442
Conversation
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -0,0 +1,586 @@ | |||
| # Query Client Docs Completion Implementation Plan | |||
|
|
|||
| > **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. | |||
|
|
||
| ## Returns | ||
|
|
||
| `QueryState<OperationInfiniteData<TData, TParameters>, TError> | undefined` - The current cache state for the infinite query, or `undefined` if the infinite query is not in the cache. |
|
|
||
| # resetQueries(...) | ||
|
|
||
| The method resets matching queries in the `QueryClient` cache and refetches active queries. |
| yarn workspace openapi-qraft-website build | ||
| ``` | ||
|
|
||
| Expected: PASS. If dependencies are unavailable in the worktree, report the missing dependency error and keep the static validation results. |
| @@ -0,0 +1,734 @@ | |||
| # Queryable Write Operations Docs Contract Implementation Plan | |||
|
|
|||
| > **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. | |||
| ## Risks | ||
|
|
||
| - Updating all `{ path, query, header }` text mechanically would incorrectly document mutation invoke calls. | ||
| - Using `body?` everywhere can imply all writable query operation bodies are optional. The generated type decides requiredness from OpenAPI. |
|
|
||
| ## Returns | ||
|
|
||
| `QueryState<OperationInfiniteData<TData, TParameters>, TError> | undefined` - The current cache state for the infinite query, or `undefined` if the infinite query is not in the cache. |
| The function is used to refetch a list of queries by their keys. | ||
| The API is the same as [_cancelQueries(...)_](cancelQueries.mdx) Hook. | ||
| See also the TanStack [_queryClient.resetQueries(...) 🌴_](https://tanstack.com/query/latest/docs/reference/QueryClient#queryclientresetqueries) documentation. | ||
| The method resets matching queries in the `QueryClient` cache and refetches active queries. |
@check-spelling-bot Report🔴 Please reviewSee the 📂 files view, the 📜action log, or 📝 job summary for details.Unrecognized words (5)agentic These words are not needed and should be removedRefetchesTo accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands... in a clone of the git@github.com:OpenAPI-Qraft/openapi-qraft.git repository curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' |
perl - 'https://github.com/OpenAPI-Qraft/openapi-qraft/actions/runs/26255140691/attempts/1'
OR To have the bot accept them for you, comment in the PR quoting the following line: If the flagged items are 🤯 false positivesIf items relate to a ...
🚂 If you're seeing this message and your PR is from a branch that doesn't have check-spelling, |
2 participants
No description provided.