codegen: Add exactOperationIds option to generateEndpoints config
#5174
+877
−11
Conversation
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
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 561ce40:
|
✅ Deploy Preview for redux-starter-kit-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
issy
commented
Jan 2, 2026
Comment on lines
+11
to
+12
| export async function generateEndpoints(options: GenerationOptions & { outputFile: string }): Promise<void>; | ||
| export async function generateEndpoints(options: GenerationOptions & { outputFile?: never }): Promise<string>; |
Contributor
Author
There was a problem hiding this comment.
I'm also including this slightly off-topic change here. This allows the return type of the function (string or void) to be inferred based on whether outputFile is passed. Without this, I have to do await generateEndpoints(...) as string in my codegen setup.
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.
Currently,
@rtk-query/codegen-openapiconverts operation IDs to camelCase before generating API code. This is due to an implementation detail inoazapfts(see oazapfts/oazapfts#591). For example, if your operation ID isfetchMyJWTPleaseit will be renamed tofetchMyJwtPlease.Although this is documented behaviour, it is not always desired behaviour for library consumers. I think it would be good to offer users an escape hatch from that behaviour. In this PR I am introducing the config property
exactOperationIds?: boolean. When enabled, it will not transform any operation IDs. This comes with some additional checks to ensure that there are no missing/duplicate operation IDs, but I think it's acceptable with such an escape hatch that users should be expected to validate these things.I have added a small section to the docs to reflect this:
I believe this should resolve the following issues:
#4322
#2181
#2675
Ideally this would be implemented in
oazapfts. There are plans on the roadmap for a plugin system and a hook for naming/renaming operations. This would be ideal for a future refactor, but will have to wait until that work is completed on their side.