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:05:14 +00:00
parent 2c81283b01
commit 9b2c86b4af
1 changed files with 1 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
message/message-formats.md
View File

@@ -1,9 +1,7 @@
# Message Formats
## Response Message 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`
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.