Skip to content

style: how does one define new parameters #59

Description

@DavidSchinazi

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.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions