Can you disable certain endpoints from being generated in Tanstack react-query?

[Andrew-Chen-Wang]

Can you disable certain endpoints from being generated in Tanstack react-query? Sometimes, I have an endpoint that is SSE, so it creates red squigglies in the react-query.gen.ts file

[dosubot[bot]]

Yes! You can exclude specific endpoints using the parser.filters.operations configuration option. This filters operations at the parser level, so they won't appear in any generated output including react-query.gen.ts.

export default {
  input: 'path/to/openapi.json',
  output: 'src/client',
  parser: {
    filters: {
      operations: {
        exclude: ['GET /api/v1/sse', '/^[A-Z]+ \\/api\\/v1\\/sse/']
      }
    }
  },
  plugins: ['@tanstack/react-query']
}

You can use exact matches like 'GET /api/v1/sse' or regex patterns wrapped in forward slashes for more flexible filtering. See the Parser Configuration docs for more details.

To reply, just mention @dosu.

---

Docs are dead. Just use Dosu.

[mrlubos]

@Andrew-Chen-Wang That's actually a bug and there's an issue for that, but yes let me add this option too.

[mrlubos]

@Andrew-Chen-Wang my bad, you can actually do this already by removing classifiers from operations. You can read more about it here https://heyapi.dev/openapi-ts/configuration/parser#hooks-operations

{
  name: '@tanstack/react-query',
  "~hooks": {
    operations: {
      getKind(operation) {
        if (filterOperations(operation)) {
          return []; // <- return empty array to skip generating anything
        }
      }
    }
  }
}