Skip to content

Commit

Permalink
Update wording of top level error codes to be more prescriptive. (#463)
Browse files Browse the repository at this point in the history
* Update GuidelinesGraph.md

* Update graph/GuidelinesGraph.md

Co-authored-by: Darrel <darrmi@microsoft.com>

---------

Co-authored-by: Darrel <darrmi@microsoft.com>
  • Loading branch information
garethj-msft and darrelmiller committed Jun 30, 2023
1 parent 313753e commit 67e45a5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion graph/GuidelinesGraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ Microsoft REST API Guidelines provide guidelines that Microsoft Graph APIs shoul
}
```

The top-level error code must be aligned with HTTP response status codes according to [rfc7231 (ietf.org)](https://datatracker.ietf.org/doc/html/rfc7231#section-6). The following examples demonstrate error modeling for common use cases:
The top-level error code must match the HTTP response status code description, converted to camelCase, as listed in the [Status Code Registry (iana.org)](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). The following examples demonstrate error modeling for common use cases:

- **Simple error**: An API wants to report an error with top-level details only. The error object contains the top-level error code, message and target (optional).

Expand Down

0 comments on commit 67e45a5

Please sign in to comment.