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.61k stars 384 forks source link

refactor: RFC 9457 obsoletes 7807, refer to it #773

Closed scop closed 10 months ago

scop commented 1 year ago

No substantial changes that would run at odds with the elaboration in the guidelines that I can see.

tfrauenstein commented 1 year ago

👍

ePaul commented 11 months ago

Thanks for the pointer, I missed this new RFC.

There are these changes from RFC-7807 to RFC-9457 (mentioned in the Appendix D) :

tkrop commented 11 months ago

Section 3 clarifies how multiple problems should be treated

For multiple problems of the same type, use an extension with more problem objects in it (only the relevant fields). For multiple problems of different types, just keep the most important/urgent one.

Section 3.1.1 provides guidance for using type URIs that cannot be dereferenced

@epaul I don't think that the difference is so big compared to the short sentences in https://www.rfc-editor.org/rfc/rfc7807#section-3.1. We deliberately decided to not follow the convention of absolute URIs to relief our API designers from providing a registry of error types. I still support this decision.

tkrop commented 11 months ago

👍