-
-
Notifications
You must be signed in to change notification settings - Fork 532
feat(openapi-fetch): add transform options for response data handling #2253
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
🦋 Changeset detectedLatest commit: 9321c34 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for submitting! The “this is not achievable in middleware” callout is a great observation, and would also like to fix. Thank you for the proposal!
But since this is a bigger change, I’d like to pause on this and back up to a proposal first. Please Open an issue that has a more in-depth proposal for how you’d like to fix this flaw in middleware, and discuss some tradeoffs.
Adding another API that is 90% similar to what the middleware is doing now, but with some minor differences, isn’t a cohesive API design because it gives users multiple ways to accomplish the same goals.
Instead, I’d love to see a proposal that goes more in depth on:
- How is the current middleware API sufficient?
- What serialization/deserialization is needed?
- What are some alternatives—how might the middleware API be modified to accomplish these goals?
Thinking through this more holistically will benefit more users, and end up as a stronger design. To that end, would love to align more on the plan so we fix the real problems you’re pointing out, but in a way that improves everyones’ experience.
Changes
This PR adds the option to transform the response data. This is useful when you want to deserialize the returned output. This is not achievable via middleware.
How to Review
I would personally start from reading the test. The PR is quite minimal.
Checklist
docs/
updated (if necessary)pnpm run update:examples
run (only applicable for openapi-typescript)