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-03 10:13:28 +00:00
parent 431bc96dd7
commit 3017f8bdee
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
message/message-formats.md
View File

@@ -1,16 +1,22 @@
# 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 the [`application/vnd.siren+json`](https://github.com/kevinswiber/siren) (Siren) format.
The format MUST not be used directly but instead it MUST be used as the base format for every application or domain-specific 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
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.
## Request Message Format
[`application/x-www-form-urlencoded`](https://tools.ietf.org/html/rfc1866#section-8.2.1)
[`application/json`](http://www.json.org)
Data body **request** messages MUST support the [`application/json`](http://www.json.org) (JSON) 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`
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.