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

style: how does one define new parameters #59

Open
DavidSchinazi opened this issue Jun 13, 2024 · 1 comment
Open

style: how does one define new parameters #59

DavidSchinazi opened this issue Jun 13, 2024 · 1 comment

Comments

@DavidSchinazi
Copy link
Contributor

The Concealed auth draft defines new HTTP authentication parameters. Over in httpwg/http-extensions#2801 we realized that the syntax for how to define new parameters and how to refer to those parameters wasn't consistent. I went to check the style guide, and there was no guidance. I picked something consistent for that draft, but it would be good to provide guidance in the style guide, similar to the guidance we provide for header field names.

For what it's worth, what I picked in that draft was:

  • when defining a new parameter:

The REQUIRED "s" (signature) Parameter is an integer that specifies...

  • when referencing the parameter:

The key ID sent in the k Parameter...

Note that "Parameter" is uppercase here, would be good to suggest whether upper- vs lower-case is preferred.

@mnot
Copy link
Member

mnot commented Jun 13, 2024

Capitalising "Parameter" may confuse people with Structured Fields terminology; HTTP auth doesn't use SF.

Otherwise looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants