Skip to content

docs(codegen): fix malformed config options block - #5366

Open
aryaemami59 wants to merge 1 commit into
reduxjs:masterfrom
aryaemami59:docs/codegen/fix-config-options-block
Open

aryaemami59 wants to merge 1 commit into
reduxjs:masterfrom
aryaemami59:docs/codegen/fix-config-options-block

Conversation

@aryaemami59

@aryaemami59 aryaemami59 commented Aug 12, 2026 •

Copy link
Copy Markdown
Member

The SimpleUsage interface in the code generation docs 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

Docs-only, no runtime change. The site builds.

Introduced in: #5135, #5304

Closes #5369
Ref #5368

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)
@codesandbox

codesandbox Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

@netlify

netlify Bot commented Aug 12, 2026

Copy link
Copy Markdown

✅ Deploy Preview for redux-starter-kit-docs ready!

Name Link
🔨 Latest commit 7f436cd
🔍 Latest deploy log https://app.netlify.com/projects/redux-starter-kit-docs/deploys/6a7c294b99da77000872a17d
😎 Deploy Preview https://deploy-preview-5366--redux-starter-kit-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@aryaemami59 aryaemami59 self-assigned this Aug 12, 2026
@aryaemami59 aryaemami59 added Documentation Improvements or additions to documentation RTKQ-Codegen Issues related to the @rtk-query/codegen-openapi package. labels Aug 12, 2026
@pkg-pr-new

pkg-pr-new Bot commented Aug 12, 2026

Copy link
Copy Markdown

Open in StackBlitz

@reduxjs/rtk-codemods

npm i https://pkg.pr.new/@reduxjs/rtk-codemods@7f436cd -D
yarn add https://pkg.pr.new/@reduxjs/rtk-codemods@7f436cd.tgz -D
pnpm add https://pkg.pr.new/@reduxjs/rtk-codemods@7f436cd.tgz -D
bun add https://pkg.pr.new/@reduxjs/rtk-codemods@7f436cd.tgz -D

@rtk-query/codegen-openapi

npm i https://pkg.pr.new/@rtk-query/codegen-openapi@7f436cd -D
yarn add https://pkg.pr.new/@rtk-query/codegen-openapi@7f436cd.tgz -D
pnpm add https://pkg.pr.new/@rtk-query/codegen-openapi@7f436cd.tgz -D
bun add https://pkg.pr.new/@rtk-query/codegen-openapi@7f436cd.tgz -D

@rtk-query/graphql-request-base-query

npm i https://pkg.pr.new/@rtk-query/graphql-request-base-query@7f436cd -D
yarn add https://pkg.pr.new/@rtk-query/graphql-request-base-query@7f436cd.tgz -D
pnpm add https://pkg.pr.new/@rtk-query/graphql-request-base-query@7f436cd.tgz -D
bun add https://pkg.pr.new/@rtk-query/graphql-request-base-query@7f436cd.tgz -D

@reduxjs/toolkit

npm i https://pkg.pr.new/@reduxjs/toolkit@7f436cd -D
yarn add https://pkg.pr.new/@reduxjs/toolkit@7f436cd.tgz -D
pnpm add https://pkg.pr.new/@reduxjs/toolkit@7f436cd.tgz -D
bun add https://pkg.pr.new/@reduxjs/toolkit@7f436cd.tgz -D

commit: 7f436cd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation RTKQ-Codegen Issues related to the @rtk-query/codegen-openapi package.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(codegen): fix malformed config options block

1 participant