In the types, require using $.response to build a response.#1930
Open
pmcelhaney wants to merge 1 commit intomainfrom
Open
In the types, require using $.response to build a response.#1930pmcelhaney wants to merge 1 commit intomainfrom
pmcelhaney wants to merge 1 commit intomainfrom
Conversation
This file contains hidden or 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
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.
At the type level, require operation handlers to use $.response.
This no longer type checks:
And neither does this:
Use the response builder instead.
The first two examples will still work at runtime, so I'm leaning toward not calling this a breaking change.
In the future this will allow us to change the shape of a response at runtime without breaking changes.
It also pushes agents generating code to use $.response instead of returning an object that just happens to be the right shape.