v3.1.2: Clarify how to describe no response content #4611
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
We decided that the lack of `content` doesn't guarantee a lack of response content, but that noting a `Content-Length` of `0` does.
|
I'm a little uncertain on this because the HTTP spec is very squirrelly around |
handrews
changed the title
handrews
changed the title
| @@ -2079,7 +2079,7 @@ headers: | |||
| type: integer | |||
| ``` | |||
|
|
|||
| Response with no return value: | |||
| A response with no return value can be specified by omitting the `content` field, although this technically does not enforce a lack of content, it merely indicates that none is documented: | |||
There was a problem hiding this comment.
"no return value" is not very clear (some might say a response's "return value" is its HTTP response code) -- we should say "with no message body", or perhaps "zero length response body".
There was a problem hiding this comment.
@karenetheridge good catch- let me think on how to frame this more clearly.
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 #3536.
We decided that the lack of
contentdoesn't guarantee a lack of response content, but that noting aContent-Lengthof0does. @karenetheridge pointed out that we can set theContent-Lengthheader to clarify this.