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

Conversation

crossaw
Copy link

@crossaw crossaw commented Jan 10, 2025

The entry for "HTTP Content" now contains the details formerly described here. This rewrite makes this entry something of a historical record, which is useful since people will likely be using the word "payload" in its former context for many years.

Description

Motivation

Additional details

Related issues and pull requests

The entry for "HTTP Content" now contains the details formerly described here.  This rewrite makes this entry something of a historical record, which is useful since people will likely be using the word "payload" in its former context for many years.
@crossaw crossaw requested a review from a team as a code owner January 10, 2025 22:40
@crossaw crossaw requested review from hamishwillee and removed request for a team January 10, 2025 22:40
@github-actions github-actions bot added Content:Glossary Glossary entries size/s [PR only] 6-50 LoC changed labels Jan 10, 2025
Copy link
Contributor

github-actions bot commented Jan 10, 2025

Preview URLs

External URLs (3)

URL: /en-US/docs/Glossary/Payload_body
Title: Payload body

(comment last updated: 2025-01-13 10:56:36)

crossaw and others added 2 commits January 10, 2025 16:46
The bot changed my double spaces to single spaces after periods.  That's fine.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
The bot turned my absolute link into a relative link.  I should have done that myself.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@Josh-Cena Josh-Cena requested review from bsmth and removed request for hamishwillee January 10, 2025 22:59
@estelle estelle changed the title Rewrite index.md to deprecate "Payload Body" per RFC 9110 Glossary: deprecate "Payload Body" per RFC 9110 Jan 11, 2025
```

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)

@@ -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".

@bsmth
Copy link
Member

bsmth commented Jan 14, 2025

Thanks @crossaw - a couple of suggestions for you above!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants