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

HTTP status code pages imply the optional reason phrase is a required part of the status code #37057

Open
angleKH opened this issue Dec 3, 2024 · 0 comments
Labels
Content:HTTP HTTP docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@angleKH
Copy link
Contributor

angleKH commented Dec 3, 2024

MDN URL

https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

What specific section or headline is this issue about?

HTTP Status codes

What information was incorrect, unhelpful, or incomplete?

The status codes are presented in the documentation and their respective pages are presented as if both the status code (e.g. 500) and reason phrase (e.g. Internal Server Error) are both part of a single one required token.

However from what I can gather, according to the official standards, the reason phrase is optional in HTTP/1.1 and not supported in HTTP/2.

From RFC 9110:

The reason phrases listed here are only recommendations -- they can be replaced by local equivalents or left out altogether without affecting the protocol.

What did you expect to see?

It should be made more clear that the status code and reason phrase are distinct, and noted that the reason phrase is optional.

Example: Instead of linking to a status code page like 400 Bad Request as it is currently it can be linked to like 400 (Bad Request).

Each individual page status page currently has a section titled "Status" where it presents the status code along with the reason phrase, this will also need to be adjusted and seperated into a "Status code" and "Recommended reason phraae" section.

Do you have any supporting links, references, or citations?

https://stackoverflow.com/a/38655533

Do you have anything more you want to share?

No response

MDN metadata

Page report details
@angleKH angleKH added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Dec 3, 2024
@github-actions github-actions bot added the Content:HTTP HTTP docs label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:HTTP HTTP docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

1 participant