Skip to content
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

Binary media types list #29

Merged
merged 9 commits into from
Jan 17, 2024
Merged

Conversation

JackKelly-Bellroy
Copy link
Member

@JackKelly-Bellroy JackKelly-Bellroy commented Jan 16, 2024

A careful reading between the lines of the API Gateway documentation implies that if binaryMediaTypes is not set on the API Gateway, all responses are considered to be text. So we should be able to get away with an explicit list of media types that require binary responses, and we can ask the developer to ensure that it matches the binaryMediaTypes setting on his or her API.

Also document accidental breakage and improve ergonomics. @jaspervdj I'd be interested to hear if this works better for you than 0.3.0.0.

Copy link
Contributor

@jaspervdj jaspervdj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

test/Network/Wai/Handler/HalTest.hs Outdated Show resolved Hide resolved
src/Network/Wai/Handler/Hal.hs Outdated Show resolved Hide resolved
src/Network/Wai/Handler/Hal.hs Outdated Show resolved Hide resolved
A careful reading between the lines of the [API Gateway documentation][1]
implies that if `binaryMediaTypes` is not set on the API Gateway, all
responses are considered to be text. So we should be able to get away
with an explicit list of media types that require binary responses,
and we can ask the developer to ensure that it matches the
`binaryMediaTypes` setting on his or her API.

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-workflow.html
@JackKelly-Bellroy JackKelly-Bellroy merged commit 4fbe6c3 into master Jan 17, 2024
14 checks passed
@JackKelly-Bellroy
Copy link
Member Author

Published as 0.4.0.0.

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.

4 participants