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:19:47 +00:00
parent 9b2c86b4af
commit 9445e443d8
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
message/error-reporting.md
View File

@@ -1,4 +1,6 @@
# Error Reporting
The [`application/vnd.error+json`](https://github.com/blongden/vnd.error) (vnd.error) MUST be used to communicate details about an error.
The [`application/problem+json`](https://tools.ietf.org/html/rfc7807) (Problem Detail) MUST be used in conjunction with Siren to communicate details about an error.
> 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

3
message/message-formats.md
View File

@@ -4,8 +4,7 @@
All **response** messages MUST support an [`application/hal+json`](http://stateless.co/hal_specification.html) (HAL) **based** format.
### Error Response Format
Siren-based format MUST be used to communicate a problem (error). This format SHOULD be application or domain-specific accordingly to non-error response format.
Siren-based format MUST be used to communicate a problem (error). This format SHOULD be application or domain-specific accordingly to non-error response format.
## Request Message Format
Data body **request** messages MUST support a [`application/json`](http://www.json.org) (JSON) **based** format.