Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates message/error-reporting.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-07 13:28:35 +00:00
parent 9445e443d8
commit f109cea36b
2 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
message/error-reporting.md
View File

@@ -4,3 +4,30 @@ The [`application/vnd.error+json`](https://github.com/blongden/vnd.error) (vnd.e
> vnd.error media type is intended for use with the HTTP status codes 4xx and 5xx, though this does not exclude it from use in any other scenario.
#### Example
A request is made to retrieve a resource representation:
```
GET /greeting HTTP/1.1
Accept: application/hal+json
```
However in order to make this request the client needs to be authorized. Since the request is made without the authorization credentials the **401 Unauthorized** response is returned together with details using the `vnd.error+json` media type:
```
HTTP/1.1 401 Unauthorized
Content-Type: application/vnd.error+json
{
"message": "Authentication required. Missing authentication credentials for the target resource.",
"logref": "REQ0001,
"_links": {
"about": {
"href": "/greeting"
}
}
}
```
The `about` link relation type is the resource (URI) this vnd.error instance is about.