Dear fellow OpenAPI enthusiasts,
I am refering to REST API Design Guidelines Part 1, Version 4.0.2, from 13-Jan-2021.
In the guide on page 19ff, chapter 3.4, there is a definition of an "Error Representation" in the body of the response with properties like code, reason, message and so on.
On the other hand, there is RFC7807 from
https://datatracker.ietf.org/doc/html/rfc7807, which also describes a somewhat similar Problem Details Object for HTTP APIs with completely different definition especially with different properties like type, title, status, detail and so on.
But the intentions of the object/representation are the same.
Here's my question:
What were the reasons not taking RFC7807 into account for the definition of the "Error Representation" in REST API Design Guidelines, chapter 3.4 ?
Does anybody have some background information on this because we had a long discussion what definition is to be used and why are there 2 different definitions?
Maybe I did not understand the texts of REST API Design Guidelines and the RFC or I miss a point.
Any help or insight is appreciated.
Kind regards
Raoul Piechatzek
------------------------------
Raoul Piechatzek
Deutsche Telekom AG
------------------------------