Skip to content
Snippets Groups Projects
Commit cd0e0ad1 authored by Jonas Gröger's avatar Jonas Gröger :palm_tree:
Browse files

Merge branch 'fix-problem-schema-url' into 'main' 

Update 5_Fehlerverhalten_und_Statuscodes.md

See merge request fit-connect/api!42
parents 29c00f69 9c9912e5
No related branches found
No related tags found
1 merge request!42Update 5_Fehlerverhalten_und_Statuscodes.md
Hide whitespace changes
Inline Side-by-side
docs/5_Fehlerverhalten_und_Statuscodes.md
+ 29
− 28
View file @ cd0e0ad1
......@@ -13,7 +13,7 @@ Diese Seite gibt einen Überblick über Fehlerhandling in der XFall RESTful API
nach [RFC 7807 (Problem Details for HTTP APIs)](https://datatracker.ietf.org/doc/html/rfc7807) aus.
* Fehler besitzen **immer** folgende Felder:
* `type`: Eine URI (möglicherweise als Website aufrufbar) die den Typ des Fehlers eindeutig klassifiziert.
Beispiel: `https://fitko.uber.space/problem/application-not-found`
Beispiel: `https://schema.fitko.de/fit-connect/problems/application-not-found`
* `title`: Ein kurzer und menschenlesbarer Titel des Fehlers. Beispiel: `Application not found`
* `status`: Eine Kopie des HTTP Statuscodes
* Fehler können **optional** weitere Felder beinhalten. API Clients **müssen** hiermit umgehen können.
......@@ -30,36 +30,37 @@ abgebildet. Fachliche schon.
### Technische Fehler
| `type` des technischen Fehlers | Titel laut [httpstatus.es](https://httpstatuses.com/) | Beschreibung |
|---------------------------------------------------------------|---------------------------------------------------------|--------------|
| https://fitko.uber.space/problem/constraint-violation | 400 Bad Request | |
| https://fitko.uber.space/problem/request-binding-error | 400 Bad Request | |
| https://fitko.uber.space/problem/no-handler-found | 404 Not Found | |
| https://fitko.uber.space/problem/missing-request-part | 400 Bad Request | |
| https://fitko.uber.space/problem/missing-request-parameter | 400 Bad Request | |
| https://fitko.uber.space/problem/socket-timeout | 504 Gateway Timeout | |
| https://fitko.uber.space/problem/type-mismatch | 400 Bad Request | |
| https://fitko.uber.space/problem/multipart-error | 400 Bad Request | |
| https://fitko.uber.space/problem/message-not-readable | 400 Bad Request | |
| https://fitko.uber.space/problem/method-not-supported | 405 Method Not Allowed | |
| https://fitko.uber.space/problem/media-type-not-supported | 415 Unsupported Media Type | |
| https://fitko.uber.space/problem/media-type-not-acceptable | 406 Not Acceptable | |
| https://fitko.uber.space/problem/unsupported-operation | 501 Not Implemented | |
| https://fitko.uber.space/problem/invalid-state-transition | 500 Internal Server Error | |
| `type` des technischen Fehlers | Titel laut [httpstatus.es](https://httpstatuses.com/) | Beschreibung |
|------------------------------------------------------------------------|---------------------------------------------------------|--------------|
| https://schema.fitko.de/fit-connect/problems/constraint-violation | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/request-binding-error | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/no-handler-found | 404 Not Found | |
| https://schema.fitko.de/fit-connect/problems/missing-request-part | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/missing-request-parameter | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/socket-timeout | 504 Gateway Timeout | |
| https://schema.fitko.de/fit-connect/problems/type-mismatch | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/multipart-error | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/message-not-readable | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/method-not-supported | 405 Method Not Allowed | |
| https://schema.fitko.de/fit-connect/problems/media-type-not-supported | 415 Unsupported Media Type | |
| https://schema.fitko.de/fit-connect/problems/media-type-not-acceptable | 406 Not Acceptable | |
| https://schema.fitko.de/fit-connect/problems/unsupported-operation | 501 Not Implemented | |
| https://schema.fitko.de/fit-connect/problems/invalid-state-transition | 500 Internal Server Error | |
### Fachliche Fehler
| `type` des fachlichen Fehlers | Titel laut [httpstatus.es](https://httpstatuses.com/) | Beschreibung |
|---------------------------------------------------------------|---------------------------------------------------------|--------------|
| https://fitko.uber.space/problem/access-forbidden | 403 Forbidden | |
| https://fitko.uber.space/problem/application-already-fetched | 410 Gone | |
| https://fitko.uber.space/problem/application-incomplete | 422 Unprocessable Entity | |
| https://fitko.uber.space/problem/application-not-found | 404 Not Found | |
| https://fitko.uber.space/problem/not-in-acknowledgeable-state | 422 Unprocessable Entity | |
| https://fitko.uber.space/problem/attachment-not-announced | 422 Unprocessable Entity | |
| https://fitko.uber.space/problem/attachment-not-found | 404 Not Found | |
| https://fitko.uber.space/problem/destination-not-found | 404 Not Found | |
| https://fitko.uber.space/problem/empty-attachment | 400 Bad Request | |
| `type` des fachlichen Fehlers | Titel laut [httpstatus.es](https://httpstatuses.com/) | Beschreibung |
|---------------------------------------------------------------------------|---------------------------------------------------------|--------------|
| https://schema.fitko.de/fit-connect/problems/access-forbidden | 403 Forbidden | |
| https://schema.fitko.de/fit-connect/problems/application-already-fetched | 410 Gone | |
| https://schema.fitko.de/fit-connect/problems/application-incomplete | 422 Unprocessable Entity | |
| https://schema.fitko.de/fit-connect/problems/application-not-found | 404 Not Found | |
| https://schema.fitko.de/fit-connect/problems/not-in-acknowledgeable-state | 422 Unprocessable Entity | |
| https://schema.fitko.de/fit-connect/problems/attachment-not-announced | 422 Unprocessable Entity | |
| https://schema.fitko.de/fit-connect/problems/attachment-not-found | 404 Not Found | |
| https://schema.fitko.de/fit-connect/problems/destination-not-found | 404 Not Found | |
| https://schema.fitko.de/fit-connect/problems/empty-attachment | 400 Bad Request | |
| https://schema.fitko.de/fit-connect/problems/jwk-not-valid | 422 Unprocessable Entity | JWK fachlich nicht zulässig. Details stehen im Feld `detail`. |
## Verhalten von API Clients
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment