Skip to content

Commit 7c7544d

Browse files
authored
Merge pull request #515 from microsoft/olgapo-movingREST
updated inner error message
2 parents f373897 + 21c018c commit 7c7544d

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

graph/Guidelines-deprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
> # DEPRECATION NOTICE TO READERS
33
>
4-
> <mark>This document is being deprecated and merged with the [Microsoft Graph REST API Guidelines](GuidelinesGraph.md), with a removal date of 07/01/2024.</mark> Please refer to the notes below for the latest guidance.
4+
> This document is being deprecated and merged with the [Microsoft Graph REST API Guidelines](GuidelinesGraph.md), with a removal date of July 1, 2024. Please refer to the notes below for the latest guidance.
55
>
66
> ## **Guidance for Microsoft Graph service teams**
77
>

graph/GuidelinesGraph.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ For an additional list of standard HTTP methods, see the [RFC7230](https://www.r
269269

270270
### Error handling
271271

272-
To improve API traceability and consistency you MUST use the recommended Microsoft Graph error model and the Microsoft Graph utilities library to provide a standard implementation for your service:
272+
To improve API traceability and consistency you MUST use the recommended Microsoft Graph error model and the Microsoft Graph utilities library to provide a standard implementation for your service. The value for the "message" name/value pair MUST be a human-readable representation of the error, tailored to provide enough information for the developer to understand the error and take appropriate action. The message is intended only as an aid to developers and should not be exposed to end users.
273273

274274
```http
275275
{
@@ -278,8 +278,7 @@ For an additional list of standard HTTP methods, see the [RFC7230](https://www.r
278278
"message": "Cannot process the request because a required field is missing.",
279279
"target": "query",
280280
"innererror":{
281-
"code": "requiredFieldMissing",
282-
"message": "A required field is missing.",
281+
"code": "requiredFieldMissing"
283282
}
284283
}
285284
```
@@ -304,10 +303,9 @@ The top-level error code MUST match the HTTP response status code description, c
304303
{
305304
"error": {
306305
"code": "badRequest",
307-
"message": "Cannot process the request because it is malformed or incorrect.",
306+
"message": "Cannot process the request because a required field is missing.",
308307
"innererror": {
309-
"code": "requiredFieldOrParameterMissing",
310-
"message": "A required field or parameter is missing.",
308+
"code": "requiredFieldOrParameterMissing"
311309
}
312310
}
313311
}
@@ -320,7 +318,7 @@ The top-level error code MUST match the HTTP response status code description, c
320318
| :heavy_check_mark: **MUST** return a 429 Too Many Requests error when the client exceeded throttling limits, and a 503 Service Unavailable error when the service overloaded but the client is within throttling limits.|
321319
| :ballot_box_with_check: **SHOULD** return a 404 Not Found error if a 403 error would result in information disclosure. |
322320

323-
For additional guidance, see [Error condition responses article](./articles/errorResponses.md).
321+
For more detailed guidance, see the article on [Error condition responses](./articles/errorResponses.md).
324322

325323
For a complete mapping of error codes to HTTP statuses, see
326324
[rfc7231 (ietf.org)](https://datatracker.ietf.org/doc/html/rfc7231#section-6).

0 commit comments

Comments
 (0)