microsoft / microsoft/api-guidelines

Add guidance for support of HTTP/2

Open
#306 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Azure Guidelines
Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

We should add guidance for teams that want to support HTTP/2. In particular, HTTP/2 requires header names to be all lower-case, as opposed to HTTP/1.1 which just said that they are case-insensitive.

Potential guidance could include that HTTP/2 support is enabled only in a new API version. That would allow clients to "opt-in" to using HTTP/2 or "opt-out" if they are not written to expect the subtle differences.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no file, test, or entry point; first inspect the repository’s existing API-versioning and protocol guidance. Done means adding agreed guidance for HTTP/2 support, including lower-case headers and the proposed opt-in or opt-out API-version approach.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation, networking
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.