From 0104ec7a2049892052081b46dc0d145070c37902 Mon Sep 17 00:00:00 2001 From: apidesigner Date: Fri, 3 Feb 2017 10:20:56 +0000 Subject: [PATCH] Updates message/error-reporting.md Auto commit by GitBook Editor --- message/error-reporting.md | 5 ++++- message/message-formats.md | 15 +++++---------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/message/error-reporting.md b/message/error-reporting.md index d8bfa93..1975cdb 100644 --- a/message/error-reporting.md +++ b/message/error-reporting.md @@ -1 +1,4 @@ -# Error Reporting \ No newline at end of file +# 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. + diff --git a/message/message-formats.md b/message/message-formats.md index d91d8bf..234bb2f 100644 --- a/message/message-formats.md +++ b/message/message-formats.md @@ -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. - - - - -