Respond with 404 status for single resources that do not exist

[buschtoens]

In accordance with the JSONAPI spec (Fetching Resources > 404 Not Found) Katharsis must respond with a 404 Not Found status for requests to single resources that do not exist. It currently responds with 200 Ok.

The response body is also incorrect:

{
  "data": null,
  "included": []
}

Although the empty included array is unnecessary, it is not illegal per se, as data is provided. However, "data": null is illegal in this context and so included is also.

Instead Katharsis should either respond with an empty response body (discouraged) or a proper errors field. There's an issue over at json-api/json-api#1122 (comment) elaborating on that.

The perfect response would look similar to this:

HTTP/1.1 404 Not Found
Content-Type: application/vnd.api+json

{
  "links": {
    "self": "http://example.com/authors/unknown-author"
  },
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "Could not find a resource of type 'author' with id 'unknown-author'."
    }
  ]
}

The only exception to this rule is when requesting a single resource via a relationship link that is not yet set:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "links": {
    "self": "http://example.com/articles/1/author"
  },
  "data": null
}

[chb0github]

Definitely a bug. Pr is welcome

…

On Thu, Dec 22, 2016, 1:17 AM Jan Buschtöns ***@***.***> wrote: In accordance with the JSONAPI spec (Fetching Resources > 404 Not Found <http://jsonapi.org/format/#fetching-resources-responses-404>) Katharsis must respond with a 404 Not Found status for requests to single resources that do not exist. It currently responds with 200 Ok. The response body is also incorrect: { "data": null, "included": [] } Although the empty included array is unnecessary, it is not illegal per se, as data is provided. However, "data": null is illegal in this context and so included is also. Instead Katharsis should either respond with an empty response body (discouraged) or a proper errors field. There's an issue over at json-api/json-api#1122 (comment) <json-api/json-api#1122 (comment)> elaborating on that. The perfect response would look similar to this: HTTP/1.1 404 Not Found Content-Type: application/vnd.api+json { "links": { "self": "http://example.com/authors/unknown-author" }, "errors": [ { "status": "404", "title": "Not Found", "detail": "Could not find a resource of type 'author' with id 'unknown-author'." } ] } The only exception to this rule is when requesting a single resource via a relationship link that is not yet set: HTTP/1.1 200 OK Content-Type: application/vnd.api+json { "links": { "self": "http://example.com/articles/1/author" }, "data": null } — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#272>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABaI0Oi7AS5quhEL8lm94UOOWcNoSwU2ks5rKkAzgaJpZM4LTyJ9> .