Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glossary: deprecate "Payload Body" per RFC 9110 #37598

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 3 additions & 27 deletions files/en-us/glossary/payload_body/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,8 @@ page-type: glossary-definition

{{GlossarySidebar}}

The HTTP message **payload body** is the _information_ ("payload") part of the data that is sent in the HTTP Message Body (if any), prior to [transfer encoding](/en-US/docs/Web/HTTP/Headers/Transfer-Encoding) being applied. If transfer encoding is not used, the _payload body_ and _message body_ are the same!
Prior to June 2022, the **payload body** or **payload** was the resource representation being transferred in an HTTP Message Body, stripped of any [transfer encoding](/en-US/docs/Web/HTTP/Headers/Transfer-Encoding). With no transfer encoding, the _payload body_ and _message body_ are the same thing. Representation data could also be transferred in the HTTP Header, but such data would not be regarded as "payload".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Prior to June 2022, the **payload body** or **payload** was the resource representation being transferred in an HTTP Message Body, stripped of any [transfer encoding](/en-US/docs/Web/HTTP/Headers/Transfer-Encoding). With no transfer encoding, the _payload body_ and _message body_ are the same thing. Representation data could also be transferred in the HTTP Header, but such data would not be regarded as "payload".
Prior to June 2022, the **payload body** or **payload** was the resource representation transferred in an HTTP message body, stripped of any [transfer encoding](/en-US/docs/Web/HTTP/Headers/Transfer-Encoding). With no transfer encoding, the _payload body_ and _message body_ are the same thing. Representation data could also be transferred in HTTP headers, but such data would not be regarded as a "payload".


For example, in this response the message body contains only the payload body: "Mozilla Developer Network":
With the release of RFC 9110, the word **content** replaces the word **payload**. See [**HTTP content**](/en-US/docs/Glossary/HTTP_Content).

```http
HTTP/1.1 200 OK
Content-Type: text/plain

Mozilla Developer Network
```

By contrast, the below response uses _transfer encoding_ to encode the payload body into chunks. The payload body (information) sent is still "Mozilla Developer Network", but the message body includes additional data to separate the chunks:

```http
HTTP/1.1 200 OK
Content-Type: text/plain
Transfer-Encoding: chunked

7\r\n
Mozilla\r\n
9\r\n
Developer\r\n
7\r\n
Network\r\n
0\r\n
\r\n
```

For more information see [RFC 7230, section 3.3: Message Body](https://datatracker.ietf.org/doc/html/rfc7230#section-3.3) and [RFC 7230, section 3.3.1: Transfer-Encoding](https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.1).
For more information see [RFC 7230, section 3.3: Message Body](https://datatracker.ietf.org/doc/html/rfc7230#section-3.3), [RFC 7231, section 3: Representations](https://datatracker.ietf.org/doc/html/rfc7231#section-3), and [RFC 9110, appendix B.3: Changes from RFC 7231](https://datatracker.ietf.org/doc/html/rfc9110#name-changes-from-rfc-7231).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use a See also section like the other entry:

Suggested change
For more information see [RFC 7230, section 3.3: Message Body](https://datatracker.ietf.org/doc/html/rfc7230#section-3.3), [RFC 7231, section 3: Representations](https://datatracker.ietf.org/doc/html/rfc7231#section-3), and [RFC 9110, appendix B.3: Changes from RFC 7231](https://datatracker.ietf.org/doc/html/rfc9110#name-changes-from-rfc-7231).
## See also
- {{Glossary("Content header")}}
- [RFC 9110, section 6.4: Content](https://httpwg.org/specs/rfc9110.html#rfc.section.6.4) (obsoletes [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-3.3) Payload Semantics)
- [Changes from RFC 7231](https://httpwg.org/specs/rfc9110.html#changes.from.rfc.7231)

Loading