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.

Sign up for GitHub

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

Jump to bottom

feat(http): Update some mentions of "payload" -> "content" #35335

Merged
merged 9 commits into from
Aug 30, 2024
Merged

feat(http): Update some mentions of "payload" -> "content" #35335

merged 9 commits into from
Aug 30, 2024

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Aug 6, 2024

Description

Replaces #35063 because of git hijinks.
This is a maintenance PR part of work to refresh HTTP docs.

Fixes #20741 which looks like a simple change, but it's trickier because we have to be more abstract to encompass HTTP/1.1 -> HTTP/3 concepts.

Changes:

  • Payload_body -> HTTP_Content
  • Payload_header -> Content_header
  • Contextual update to:
    • Transfer encoding
    • Content encoding
    • 413 status err
  • Other instances of "payload" -> "content" where it makes sense, not everywhere.

Motivation

Keeping content up-to-date and useful.

Related issues and pull requests:

@bsmth bsmth requested a review from hamishwillee August 6, 2024 13:43
@bsmth bsmth requested review from a team as code owners August 6, 2024 13:43
@github-actions github-actions bot added Content:HTTP HTTP docs Content:Glossary Glossary entries labels Aug 6, 2024
@bsmth bsmth removed request for a team August 6, 2024 13:43
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Aug 6, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 6, 2024 •
edited
Loading

Preview URLs (19 pages)
Flaws (49)

Note! 4 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/HTTP/Methods
Title: HTTP request methods
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Methods/PATCH
Title: PATCH
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Methods/PUT
Title: PUT
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Methods/GET
Title: GET
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Network_Error_Logging
Title: Network Error Logging
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/CORS
Title: Cross-Origin Resource Sharing (CORS)
Flaw count: 7

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs
  • images:
    • External image URL
    • External image URL
    • External image URL
    • External image URL

URL: /en-US/docs/Web/HTTP/Headers/Trailer
Title: Trailer
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Headers/Transfer-Encoding
Title: Transfer-Encoding
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Headers/Content-Range
Title: Content-Range
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Headers/Content-Length
Title: Content-Length
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Headers/Content-Encoding
Title: Content-Encoding
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Messages
Title: HTTP Messages
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Status/417
Title: 417 Expectation Failed
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Status/400
Title: 400 Bad Request
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Status/415
Title: 415 Unsupported Media Type
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs
External URLs (4)

URL: /en-US/docs/Glossary/Content_header
Title: Content header

URL: /en-US/docs/Glossary/HTTP_Content
Title: HTTP Content

(comment last updated: 2024-08-28 09:34:25)

@bsmth
Copy link
Member Author

bsmth commented Aug 6, 2024

@hamishwillee the other PR was... trashed from merge conflicts and git hijinks. I incorporated all of your comments, with some other clarifications that I hope make it clearer.

Because we don't see "content headers" defined in later specs, I'm not sure how useful this page is, but at least we shouldn't really be talking about "payload headers" anymore. No rush on this, btw! 🙏🏻

@hamishwillee
Copy link
Collaborator

hamishwillee commented Aug 16, 2024 •
edited
Loading

I think I was perhaps a bit picky but I found this very hard to review - mostly because until I got near the end I was still unclear on exactly how content and representation headers differ. Now I know :-) Thank you.

@bsmth
Copy link
Member Author

bsmth commented Aug 28, 2024

I think I was perhaps a bit picky but I found this very hard to review - mostly because until I got near the end I was still unclear on exactly how content and representation headers differ. Now I know :-) Thank you.

Thanks Hamish! It becomes clearer why "payload headers" are dropped in later RFCs and we're left with "representation headers" for metadata, then everything else is either a request or a response header. I think that's less confusing.

hamishwillee
hamishwillee approved these changes Aug 30, 2024
View reviewed changes
Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

Thanks very much @bsmth - LGTM.

@hamishwillee hamishwillee merged commit ae86913 into mdn:main Aug 30, 2024
9 checks passed
@yin1999 yin1999 mentioned this pull request Sep 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hamishwillee hamishwillee hamishwillee approved these changes

Assignees
No one assigned
Labels
Content:Glossary Glossary entries Content:HTTP HTTP docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

HTTP Payload Header page should be updated to use "content" term
2 participants
@bsmth @hamishwillee