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

Spec references RFC7231 which is obsoleted #201

Open
rivantsov opened this issue Jul 13, 2022 · 4 comments
Open

Spec references RFC7231 which is obsoleted #201

rivantsov opened this issue Jul 13, 2022 · 4 comments

Comments

@rivantsov
Copy link

rivantsov commented Jul 13, 2022

Here are couple of things I found that might be an issue:

Section Response

A server must comply with RFC7231.

First, it would be nice to provide RFC title along with numeric ID, just as a nice gesture to the reader.
Secondly, this RFC page has a note on top: "Obsoleted by: 9110"; should the spec reference the newer RFC? otherwise some comment is needed.

Note: If changing ref to 9110, then some other links to its subsections should be updated. Ex: link to "HTTP 1.1 Accept" section.

@michaelstaib
Copy link
Member

I agree, we should make it easier for the reader and refer to concrete sections that we refer to if possible. In the concrete case it would be content negotiation.

https://datatracker.ietf.org/doc/html/rfc9110/#section-12.4

@michaelstaib
Copy link
Member

That the specs get out of date sometimes is not so much a problem, in these case we just need to check the changelog to verify and do PR to update. I went over the changes and there is nothing changed that concerns the accept/content-negotiation semantics.

I like the suggestion adding the RFC title. Could be in braces.

@rivantsov
Copy link
Author

well, links get obsolete over time - that's understandable. But in this case, it's at time of spec publishing. Better be updated i think

@michaelstaib
Copy link
Member

Sure, the thing here is that we started work on this SPEC in 2019 so references might get obsoleted by the time we are finished with it. Before we ratify it we must go through and update spec links again. We will put an action item on this for when we do the finishing touches to go over spec references and validate / update them.

@benjie benjie added this to the 1.0 Release milestone Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants