microsoft / microsoft/api-guidelines

HTTP Return Codes don't mention HTTP HEAD

Open
#478 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

See the table https://github.com/microsoft/api-guidelines/blob/0611d2f7236b7670f887e83ac7da4c918d9cb74f/azure/Guidelines.md?plain=1#L142-L154

It lists all HTTP verbs but HEAD. And overall, this verb isn't mentioned in the guidelines. Why?

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

Open azure/Guidelines.md at lines 142-154 and review the surrounding HTTP return-code guidance. Check how the listed verbs are described and determine where HTTP HEAD should be covered. Done means the table and relevant guidelines consistently address HEAD, with documentation tests or checks passing if available.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.