feat(type-safe-api): generate infinite query hooks for smithy operations with paginated trait #531
Conversation
This file contains 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
…ons with paginated trait Instead of through the "jsonAdd" escape hatch, we now support using the @paginated trait in Smithy to generate useInfiniteQuery hooks in the TypeScript React Hooks library. The escape hatch will still work, since we still support specifying "x-paginated" for the OpenAPI use case. We achieve this by reading traits from the Smithy JSON model generated as part of the openapi projection (the model build task), and injecting them into the OpenAPI spec prior to code generation.
agdimech
approved these changes
Aug 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Instead of through the
jsonAddescape hatch, we now support using the@paginatedtrait in Smithy to generateuseInfiniteQueryhooks in the TypeScript React Hooks library. The escape hatch will still work, since we still support specifyingx-paginatedfor the OpenAPI use case.We achieve this by reading traits from the Smithy JSON model generated as part of the openapi projection (the model build task), and injecting them into the OpenAPI spec prior to code generation.
This could be replaced once smithy-lang/smithy#1609 is merged and released by implementing our own
@paginatedtrait which Smithy renders into the OpenAPI spec, though I think I prefer the solution of injecting all traits into the OpenAPI spec as it works without requiring users to change their model.