docs(codegen): document the remaining config options - #5367
Open
aryaemami59 wants to merge 3 commits into
Open
Conversation
The `SimpleUsage` interface is syntactically invalid on the published page. **`EndpointOverrides`** sits in the middle of it, closing the interface early and stranding four options outside any type, followed by a stray brace. - Close **`SimpleUsage`** and move **`EndpointOverrides`** out below it - Return **`useEnumType`**, **`enumStyle`**, **`outputRegexConstants`** and **`httpResolverOptions`** to the interface - Drop **`EndpointMatcherFunction`** from the **`filterEndpoints`** array member, since **`TextMatcher`** only accepts **`(string | RegExp)[]`** - Rename **`AtLeastOneOf`** to **`AtLeastOneKey`** to match the helper in **`types.ts`** - Close the final code block, whose fence was missing Introduced in: [**reduxjs#5135**](reduxjs#5135), [**reduxjs#5304**](reduxjs#5304)
Ten options accepted by **`CommonOptions`** were missing from the config options table, including **`exportAllSchemas`**, which already has a section of its own further down the page. - Add **`unionUndefined`**, **`encodePathParams`**, **`encodeQueryParams`**, **`includeDefault`**, **`mergeReadWriteOnly`**, **`useUnknown`**, **`esmExtensions`**, **`exportAllSchemas`** and **`prettierConfigFile`** - Spell out the supporting types, so **`filterEndpoints`** and **`endpointOverrides`** resolve to something the page defines - Note that the CLI resolves relative config paths against the config file's own directory, and which config extensions it accepts - Say which of **`providesTags`**/**`invalidatesTags`** the **`tag`** option emits for a query and for a mutation - Point **`outputFile`** at **`outputFiles`** for the multi-file case - Format the NestJS example to match the repo Prettier config The option list now matches **`CommonOptions`** and **`OutputFileOptions`** exactly, checked against the compiler rather than by eye.
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
✅ Deploy Preview for redux-starter-kit-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@reduxjs/rtk-codemods
@rtk-query/codegen-openapi
@rtk-query/graphql-request-base-query
@reduxjs/toolkit
commit: |
This was referenced Aug 12, 2026
aryaemami59
added
Documentation
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.
Builds on #5366 — that commit is included here and the diff will shrink once it merges. Review the second commit only.
Ten options accepted by
CommonOptionswere missing from the config options table, includingexportAllSchemas, which already has a section of its own further down the page.unionUndefined,encodePathParams,encodeQueryParams,includeDefault,mergeReadWriteOnly,useUnknown,esmExtensions,exportAllSchemasandprettierConfigFilefilterEndpointsandendpointOverridesresolve to something the page definesprovidesTags/invalidatesTagsthetagoption emits for a query and for a mutationoutputFileatoutputFilesfor the multi-file caseThe option list now matches
CommonOptionsandOutputFileOptionsexactly — checked by pulling the properties out oftypes.tswith the TypeScript compiler and diffing them against the table, rather than by eye.The path behaviour is the one covered by the
paths are relative to config file, not to cwdtest incli.test.ts, which came fromprocess.chdirin the CLI entry point and was not documented anywhere.Docs-only, no runtime change. The site builds and the file is Prettier-clean.
One thing left out deliberately:
operationIdTransformer,enumStyleandexportAllSchemasare documented but are not in any published release — the newest tag is@rtk-query/codegen-openapi@2.2.0and the source marks them@since 2.3.0. Happy to add "requires 2.3.0" callouts if you want them, but I did not want to guess the next version number.Closes #5370
Ref #5368