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

semantics: confusing title "Designing New Header Field Values" #214

Closed
reschke opened this issue Mar 28, 2019 · 10 comments
Closed

semantics: confusing title "Designing New Header Field Values" #214

reschke opened this issue Mar 28, 2019 · 10 comments

Comments

@reschke
Copy link
Contributor

reschke commented Mar 28, 2019

The title may be technical correct (because it's about the field value syntax), but I believe people looking for this might trip over this.

Proposal: "Designing New Header Fields"

@annevk
Copy link
Contributor

annevk commented Mar 28, 2019

Perhaps instead of two separate sections for new header field names and one for header field values they should be grouped as they were before?

The reader is probably looking for the advice on X- and how to define a value at the same time.

@reschke
Copy link
Contributor Author

reschke commented Mar 28, 2019

Ah. I believe we currently do not have any advice on header field names, but maybe we should.

@wtarreau
Copy link

wtarreau commented Mar 28, 2019 via email

@mcmanus
Copy link

mcmanus commented Mar 29, 2019

see also #30

@annevk
Copy link
Contributor

annevk commented Mar 29, 2019

@reschke I was looking at https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html and I see "Considerations for New Header Fields" which has some advice around X- at least (and is a subsection of "Header Field Names") and "Designing New Header Field Values" which we are discussing here, which is a subset of "Header Field Values". It would make sense to me to group these as a new subsection of "Message Abstraction" dealing with "New Header Fields".

@reschke
Copy link
Contributor Author

reschke commented Mar 29, 2019

Good catch. So this needs reorg in any case.

@royfielding
Copy link
Member

Yes, the initial edits that put these sections together were limited to preserve the diffs since the reorganized RFC text (to ensure we didn't lose information). I plan to do a more extensive rewrite soon to consolidate sections, make the text more readable, introduce the combined field terms, and remove 1.1 syntax-specific bits from semantics.

@mnot
Copy link
Member

mnot commented Sep 2, 2019

+1, will take a stab at this.

@mnot mnot self-assigned this Sep 2, 2019
@mnot
Copy link
Member

mnot commented Sep 3, 2019

Waiting for #47 resolution.

@mnot
Copy link
Member

mnot commented Sep 30, 2019

Consolidated those two sections. There are other things to be done (e.g., the misleading "header" nature of the title, other rewrites), but those are other issues (existing or to be raised).

@mnot mnot closed this as completed Sep 30, 2019
reschke added a commit that referenced this issue Sep 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

6 participants