search

zalando / restful-api-guidelines

A model set of guidelines for RESTful APIs and Events, created by Zalando
https://opensource.zalando.com/restful-api-guidelines/
Creative Commons Attribution 4.0 International
2.62k stars 384 forks source link

Refer to RFC 7807 for the common error object #2

Closed ePaul closed 8 years ago

ePaul commented 8 years ago

I just noticed (looking for the April fools RFCs) that there is a new RFC 7807 defining a JSON error object, which seems to be based on the draft to which we are referring in the common data objects section.

That section should be adapted to refer to this RFC instead.

The RFC defines it as application/problem+json, while our guidelines are using application/x.problem+json. I guess we need some guideline about transitioning between both, because old clients might expect the content type with x (and old servers send it with x), while new clients would expect it without x (and new servers send it without x).

hjacobs commented 8 years ago

:+1:

mostlymagic commented 8 years ago

@ePaul rather than filing an issue, why don't you submit a pull request?

ePaul commented 8 years ago

@ePaul rather than filing an issue, why don't you submit a pull request?

I noted that on a weekend, when I don't work, and filed the issue so I don't forget it. I will create a pull request as soon as I find some time to do it (if noone else does it earlier).