Skip to content

Update README.md with transform example for Blob #1193

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

Merged
merged 2 commits into from
Jul 3, 2023

Conversation

psychedelicious
Copy link
Contributor

Add example transform callback for file uploads, where the multipart/form-data has a field that should be typed as Blob.

Changes

Update the README with additional example for what I think is a common use-case.

How to Review

Maybe this is extraneous? Dunno. I see the stripe API in examples has some schemas that should have this transformation done.

Should this transformation be the default behaviour?

Checklist

  • [ ] Unit tests updated
  • README updated
  • [ ] examples/ directory updated (only applicable for openapi-typescript)

Add example `transform` callback for file uploads, where the `multipart/form-data` has a field that should be typed as `Blob`.
@drwpow
Copy link
Contributor

drwpow commented Jul 2, 2023

Thanks for adding! If you could, this would probably be great to add somewhere in the docs/ folder as well. Maybe in the Advanced docs (not too particular on the placement; it may be shuffled around, but just having it somewhere makes it more searchable)

@psychedelicious
Copy link
Contributor Author

Somehow I missed that docs/ and the docs site exist - happy to update those.

@changeset-bot
Copy link

changeset-bot bot commented Jul 2, 2023

🦋 Changeset detected

Latest commit: 9126e8b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
openapi-typescript Patch
openapi-typescript-docs Patch

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

@drwpow
Copy link
Contributor

drwpow commented Jul 3, 2023

Somehow I missed that docs/ and the docs site exist - happy to update those.

No worries. The docs are relatively new and still need some refinement (any suggestions are welcome!). I didn’t want to completely delete the README until the docs were further along; sorry for the confusion there.

@drwpow drwpow merged commit 64decb7 into openapi-ts:main Jul 3, 2023
@github-actions github-actions bot mentioned this pull request Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants