Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add best practices on working with problem detail in oas

Browse Source
This commit is contained in:
Andrzej
2019-02-26 10:04:10 +01:00
parent 6e5a0f5965
commit 7502cbfd34
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
rest-api-guidelines/functionality/message/error-reporting.md
View File

@@ -122,5 +122,9 @@ A Problem Detail response **MUST NOT** contain a program stack trace or server l
## Working with Problem Detail
An API description **SHOULD** list all the error codes with which the API responds. The error responses **SHOULD** describre the error object model schema. It is **RECOMMENDED** to include examples of a possible error response. The error description and/or error example **MAY** list all the types of errors returned for a given error code.
## External resources
There are a whole plethora of libraries working with Problem Detail, for example, see [Zalando / Problem](https://github.com/zalando/problem) \(Java\).