7nohe / openapi-react-query-codegen

OpenAPI React Query Codegen is a code generator for creating React Query (also known as TanStack Query) hooks based on your OpenAPI schema.
https://openapi-react-query-codegen.vercel.app
MIT License
298 stars 30 forks source link

Allow pageParam to be a string within generated infiniteQueries #146

Open robert-pitt-foodhub opened 2 months ago

robert-pitt-foodhub commented 2 months ago

Describe the bug Our API uses string as page parameters, such as base64 encoded global ids, however when generating infinite queries where the type of pageParam is not a number within the schema

To Reproduce

  1. Generate schemas where the page types are strings using openapi-rq --pageParam nextPageKey --nextPageParam nextPageKey -i specification.json -c axios
  2. See the generated queries/infiniteQueries.ts file for type error

OpenAPI spec file Would like to keep private

Expected behavior If the schema defines the page token as a string then the generated types should also require a string.

Screenshots

Type Error:

Screenshot 2024-09-02 at 01 35 11

Schema:

Screenshot 2024-09-02 at 01 38 01

Additional context N/A