microsoft / microsoft/api-guidelines

Inconsistent details example

Open
#182 1 comment 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

Regarding: https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md
In section 14.4.4 Example Response "details" object doesn't fit the definition of "details" in section 7.10.2, table Error: Object. Details should be Error[]

{
  "error": {
    "code": "requestLimitExceeded",
    "message": "The caller has made too many requests in the time period.",
    "details": {
      "code": "RateLimit",
       "limit": "1000",
       "remaining": "0",
       "reset": "1538152773",
      }
    }
}

It looks like in 14.4.4 "details" should be changed to "innerError".

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 Guidelines.md and compare sections 7.10.2 and 14.4.4, focusing on the Error object's details example. Update the inconsistent example so it matches the documented Error structure and naming, then verify the surrounding guideline text remains consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.