chore(http): Refresh headers r-s by bsmth · Pull Request #36590 · mdn/content

bsmth · 2024-10-31T09:38:52Z

Description

This PR refreshes a few HTTP headers pages.

common changes:

Improve See also
Capitalize Yes/No in properties table
Normalize The HTTP **`Header-Name`** (request|response) header in first sentence
Add status text to HTTPStatus macros, e.g. {{HTTPStatus("406", "406 Not Acceptable")}}
Remove improper use of quotes in and around code
Avoid escaping angle brackets in directive names in favor of backticks:

- \<directive>
+ `<directive>`

Motivation

Keeping content up-to-date, fixing formatting, unifying writing conventions

TODO:

Bad BCD queries

github-actions · 2024-10-31T09:40:22Z

Preview URLs (28 pages)

Flaws (5)

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

URL: /en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Key
Title: Sec-WebSocket-Key
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: http.headers.Sec-WebSocket-Key

URL: /en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Accept
Title: Sec-WebSocket-Accept
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: http.headers.Sec-WebSocket-Accept

URL: /en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Version
Title: Sec-WebSocket-Version
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: http.headers.Sec-WebSocket-Version

URL: /en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Protocol
Title: Sec-WebSocket-Protocol
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: http.headers.Sec-WebSocket-Protocol

URL: /en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Extensions
Title: Sec-WebSocket-Extensions
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: http.headers.Sec-WebSocket-Extensions

External URLs (19)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Reduced-Motion
Title: Sec-CH-Prefers-Reduced-Motion

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Color-Scheme
Title: Sec-CH-Prefers-Color-Scheme

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Platform
Title: Sec-CH-UA-Platform

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Reduced-Transparency
Title: Sec-CH-Prefers-Reduced-Transparency

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Bitness
Title: Sec-CH-UA-Bitness

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Arch
Title: Sec-CH-UA-Arch

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/RTT
Title: RTT

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA
Title: Sec-CH-UA

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Retry-After
Title: Retry-After

https://developers.google.com/search/blog/2011/01/how-to-deal-with-planned-site-downtime (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Repr-Digest
Title: Repr-Digest

https://www.rfc-editor.org/rfc/rfc8941 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Full-Version-List
Title: Sec-CH-UA-Full-Version-List

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Model
Title: Sec-CH-UA-Model

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Mobile
Title: Sec-CH-UA-Mobile

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Platform-Version
Title: Sec-CH-UA-Platform-Version

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-GPC
Title: Sec-GPC

https://globalprivacycontrol.org/ (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Full-Version
Title: Sec-CH-UA-Full-Version

https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Save-Data
Title: Save-Data

https://css-tricks.com/help-users-save-data/ (1 time) (Note! This may be a new URL 👀)
https://developer.chrome.com/docs/privacy-security/user-agent-client-hints (1 time) (Note! This may be a new URL 👀)
https://web.dev/articles/optimizing-content-efficiency-save-data (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-11-18 17:04:54)

hamishwillee · 2024-10-31T23:11:31Z

Aware of this. Hope to get to it next week.

bsmth · 2024-11-01T08:21:58Z

Aware of this. Hope to get to it next week.

Thanks, Hamish. There's no rush on the HTTP PRs at the moment.

bsmth · 2024-11-01T08:33:59Z

files/en-us/web/http/headers/repr-digest/index.md

+    In contrast to earlier drafts of the specification, the standard-base64-encoded digest bytes are wrapped in colons (`:`, ASCII 0x3A) as part of the [dictionary syntax](https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences).

-The registered insecure digest algorithms are: `md5`, `sha` (SHA-1), `unixsum`, `unixcksum`, `adler` (ADLER32) and `crc32c`.
+### Usage notes


We have a mix of "Usage notes" and "Description" sections, related to the previous PR. It would be good to choose a convention for that.

Yes. I vote description for broader consistency across reference docs of other types.

Not necessarily and easy change though - these usage notes are in some cases just notes. For example here you couldn't just change the heading and expect it to "work" as a fix.

changed in e996e9a

(I removed the section title in this case)

hamishwillee · 2024-11-10T23:25:29Z

files/en-us/web/http/headers/repr-digest/index.md

 {{HTTPSidebar}}

-The **`Repr-Digest`** response or request header provides a {{Glossary("digest")}} of the [selected representation](https://www.rfc-editor.org/rfc/rfc9110#section-6.4) of the target resource. It is invariant under e.g., {{HTTPHeader("Content-Encoding")}} or {{HTTPHeader("Content-Range")}}, which do affect the {{HTTPHeader("Content-Digest")}}. Furthermore, [Content Negotiation](/en-US/docs/Web/HTTP/Content_negotiation) can result in different selected representations with different representation digests.
+The HTTP **`Repr-Digest`** {{Glossary("Request header", "request")}} and {{Glossary("Response header", "response header")}} provides a {{Glossary("digest")}} of the [selected representation](https://www.rfc-editor.org/rfc/rfc9110#section-6.4) of the target resource.


We should use a glossary entry instead of RFC link for selected representation.

changed in e996e9a, what do you think?

files/en-us/web/http/headers/repr-digest/index.md

files/en-us/web/http/headers/save-data/index.md

files/en-us/web/http/headers/sec-ch-prefers-color-scheme/index.md

files/en-us/web/http/headers/sec-ch-prefers-reduced-transparency/index.md

hamishwillee

@bsmth Look great. Just a few suggestions on the early ones.

bsmth · 2024-11-13T17:06:24Z

@bsmth Look great. Just a few suggestions on the early ones.

Thanks a lot, I'll take a look shortly 🙏🏻

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>

bsmth · 2024-11-18T17:03:42Z

Thanks, Hamish. I think this is mostly done, ready for another look when you have time. I'm going to have a look at BCD for the WebSocket pages 👀

hamishwillee

@bsmth The changes you made all look good, so I am going to merge. Note that I only looked at those changes, but I was happy with the rest last time round.

Thanks very much. Nearly there!

bsmth · 2024-11-20T10:00:35Z

Thanks a lot!

* origin/xss-guide: (284 commits) Add information on default entryPoint property values (mdn#36633) Bump husky from 9.1.6 to 9.1.7 (mdn#36863) fix(performance): Typo '50ms seconds' (mdn#36861) Add spec_url & add note for bcd for `<frequency>` and `<frequency-percentage>` (mdn#36848) addresses 36583: summary icon styles (mdn#36691) Remove "simple" part 3: change to "basic" (mdn#36762) the default option of a select (mdn#36658) docs(css): Add support for `<string>` in `syntax` descriptor of @Property at-rule (mdn#36655) Fix parameter syntax for `Navigation.updateCurrentEntry()` (mdn#36852) Update CSP source expression reference (mdn#36792) chore(http): Refresh headers docs (d-k) (mdn#36075) chore(http): Refresh headers r-s (mdn#36590) Updated index.md (mdn#36845) fix : wrong method name (mdn#36843) Remove all redirects to other locales (mdn#36811) fix typos (mdn#36837) docs: update Accept-Charset status (mdn#36822) updateSelection: make more intuitive (mdn#36834) updateText: Remove false information (mdn#36832) DOMRect instance properties (mdn#36704) ...

chore(http): Refresh headers r-s

a848f0a

bsmth requested a review from a team as a code owner October 31, 2024 09:38

bsmth requested review from hamishwillee and removed request for a team October 31, 2024 09:38

github-actions bot added Content:HTTP HTTP docs size/l [PR only] 501-1000 LoC changed labels Oct 31, 2024

Merge branch 'main' into http-headers-r

52a705c

bsmth commented Nov 1, 2024

View reviewed changes

hamishwillee reviewed Nov 10, 2024

View reviewed changes