fill in OpenAPI responses description #50
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
davepacheco
reviewed
Aug 31, 2020
Yeah, I'm just leaning on that one test to do a lot of this openapi testing, but I think it's got decent coverage. |
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.
fixes #11 as described in that discussion.
This leaves as a TODO the case of the freeform
Response<Body>as OpenAPI still, technically, requires a description.We also may want to consider in the future letting consumers specify a custom description field. After further consideration, perhaps specifying the description for the success case in the
#[endpoint ... ]macro isn't that bad if developers want to specify it for freeform return types or customize it for typed responses.