Introduce structured and unstructured response headers #283
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
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.
This adds
HttpResponseHeaders<T: HttpTypedResponse, H: JsonSchema + Serialize + Send + Sync + 'static = NoHeaders>that allows for consumers to specify structured headers (that also appear in the OpenAPI output) and unstructured, ad-hoc headers that may be specified at runtime.Previously, we had been--in places--using
schemarsa little bit wrong in that we were using an intermediate form rather than its fully processed form. In particular this meant that the JSON Schema we looked at didn't always conform to the variant of JSON Schema that conforms most closely with OpenAPI v3.0.x. This delta updates our use ofschemarswhich has the upshot of both requiring some additional handling... but also recovering somedescriptionfields that we had previously discarded unintentionally. This change also pulls descriptions that had been embedded within schemas up to the parameters they describe.