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/message-formats.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-02-07 13:29:59 +00:00
parent f109cea36b
commit 0d39915c1d
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
message/message-formats.md
View File

@@ -4,12 +4,11 @@
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.
The [`application/vnd.error+json`](https://github.com/blongden/vnd.error) (vnd.error) MUST be used to communicate details about an error.
## Request Message 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. E.g. `application/vnd.example+json`.
Data body **request** messages SHOULD support a [`application/json`](http://www.json.org) (JSON) format. Where applicable the data body request message SHOULD also support the `application/hal+json` format.
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.