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-03 10:20:56 +00:00
parent eb89ce3d27
commit 0104ec7a20
2 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
message/error-reporting.md
View File

@@ -1 +1,4 @@
# Error Reporting
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.

15
message/message-formats.md
View File

@@ -1,25 +1,20 @@
# Message Formats
## Response Message Format
All **response** messages MUST support the [`application/vnd.siren+json`](https://github.com/kevinswiber/siren) (Siren) format.
All **response** messages MUST support an [`application/vnd.siren+json`](https://github.com/kevinswiber/siren) (Siren) **based** format.
The Siren format MUST NOT be used **directly**, instead it MUST be used as the **base format** for every application or domain-specific format to convey specific semantics. E.g. `application/vnd.example.siren+json`
### Error Response Format
A
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.
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 the [`application/json`](http://www.json.org) (JSON) format.
Data body **request** messages MUST support a [`application/json`](http://www.json.org) (JSON) **based** format.
The JSON format MUST NOT be used **directly**, instead it MUST be used as the **base format** for every application or domain-specific format to convey specific semantics. `application/vnd.example+json`
The JSON format MUST NOT be used **directly**, instead it MUST be used as the **base format** for every application or domain-specific format to convey specific semantics. E.g. `application/vnd.example+json`.
Data body **request** messages SHOULD also support the [`application/x-www-form-urlencoded`](https://tools.ietf.org/html/rfc1866#section-8.2.1) (URL Encoded) format.