0.17.0 Changelog draft [skip ci] #631
Merged
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
Baccata
force-pushed
the
0.17-changelog
branch
from
268fe99 to
f6d01a0
Compare
Baccata
changed the title
kubukoz
reviewed
Nov 23, 2022
kubukoz
reviewed
Nov 23, 2022
lewisjkl
reviewed
Nov 23, 2022
CHANGELOG.md
Outdated
Comment on lines
67
to
74
| ### Endpoint Specific Middleware | ||
|
|
||
| Adds the ability to have smithy4s-level middleware that is made aware of the `Server` and `Endpoint` for use in creating middleware implementations. This unlocks creating middleware that is aware of the Smithy traits (`Hints` in smithy4s) and shapes in your specification. This means the middleware can apply transformations based on traits applied in a smithy specification and it can return error responses defined in the smithy specification. An example of this is authentication. You are now able to create middleware that will check authentication on only the endpoints that require it AND you can return a smithy-defined error response when the authentication is not valid. See the [endpoint specific middleware guide](https://disneystreaming.github.io/smithy4s/docs/guides/endpoint-middleware) for more. | ||
|
|
||
|
|
||
| ### Error Response Handling Improvements | ||
|
|
||
| Streamlines and improves how error responses are mapped to their corresponding smithy4s-generated types. It now works such that IF no `X-Error-Type` header is found AND the status code doesn't map precisely to an error annotated with @httpCode AND exactly one error happens to have @error("client") without @httpCode, that error will be selected (provided the status code is in the 4xx range). Same for @error("server") and 5xx range. See the [error handling documentation](https://disneystreaming.github.io/smithy4s/docs/protocols/simple-rest-json/client#error-handling) for more. |
There was a problem hiding this comment.
Added these descriptions which I think cover all user-facing changes I made in this release. The only other changes I made I think are adding internal stuff that is not binary breaking (so probably needs no mention here?)
kubukoz
reviewed
Nov 24, 2022
kubukoz
reviewed
Nov 24, 2022
kubukoz
reviewed
Nov 24, 2022
[skip ci]
[skip ci]
daddykotex
reviewed
Nov 28, 2022
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.
Reminder: use the
[skip ci]tag in commit messages to avoid triggering un-necessary CI runs.