feat: Add useOperationIdAsQueryKey option for query key generation

[mortik]

Summary

Fix #2096

This PR adds a new configuration option useOperationIdAsQueryKey that allows users to generate query keys using the OpenAPI operation ID instead of the route string for TanStack Query implementations.

Changes

• Added useOperationIdAsQueryKey?: boolean to QueryOptions and NormalizedQueryOptions types
• Modified query key generation logic in packages/query/src/index.ts to use operation ID when enabled
• Updated normalizeQueryOptions function to handle the new option
• Added comprehensive tests in packages/query/src/utils.test.ts
• Added documentation in /docs/src/pages/reference/configuration/output.md

Configuration Example

module.exports = {
  petstore: {
    output: {
      client: 'react-query',
      override: {
        query: {
          useOperationIdAsQueryKey: true,
        },
      },
    },
    input: './petstore.yaml',
  },
};

[mortik]

This should resolve #2096

[AllieJonsson]

LGTM!

[mortik]

I realized that this approach still needs an update to include the path params like id etc. i will update the pr to include that in the querykey function

[soartec-lab]

Please give me a little time to salvage past discussions about cases where you might want to use arbitrary strings for query keys. And once a policy has been decided, it will need to be documented in the documentation to avoid any confusion.

[soartec-lab]

Hi, @mortik Sorry for the long wait, I've retraced the steps so far.

First, if you want to customize the query key, you can currently do so by using override.query.querykey.

https://orval.dev/reference/configuration/output#querykey

For mutator, starting with #1730, the operationId defined in the OpenAPI is now used as the query key by default.

• feat(query): Add default mutation key #1730

Other discussions:

• Customize default query keys #243

---

With this change, when you add an option, the OpenAPI operationId will be used as the query key by default. This makes sense to me, as it's the same behavior as the default for mutator 👍

[soartec-lab]

@mortik I added a question.

[soartec-lab]

Should this be common and no separation is necessary?

Suggested change

	? [`'${operationName}'`, ...queryKeyPathParams]
	: routeString;
	? operationName : routeString;

[soartec-lab]

@mortik
I still don't understand why this change is necessary so could you explain for me?
Or, incorporate this change.

#2314 (comment)

[melloware]

@mortik looks like conflicts too

[mortik]

Hi, @mortik Sorry for the long wait, I've retraced the steps so far.

First, if you want to customize the query key, you can currently do so by using override.query.querykey.

https://orval.dev/reference/configuration/output#querykey

For mutator, starting with #1730, the operationId defined in the OpenAPI is now used as the query key by default.

• feat(query): Add default mutation key #1730

Other discussions:

• Customize default query keys #243

With this change, when you add an option, the OpenAPI operationId will be used as the query key by default. This makes sense to me, as it's the same behavior as the default for mutator 👍

i tried to use the override.query.querykey option but sadly the function does not get the nescessary information from the schema to use, for example, the operationId as a querykey. Would also be an interessting change if the custom query key function would get more context information to change the default querykey behavior.

[mortik]

@mortik looks like conflicts too

i resolved the conflict :)