major update
This commit is contained in:
15
docs/api.md
15
docs/api.md
@@ -1,6 +1,6 @@
|
||||
# REST-API (v1)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-21
|
||||
Letzte Aktualisierung: 2026-02-25
|
||||
|
||||
## Single Source of Truth
|
||||
|
||||
@@ -15,6 +15,19 @@ Diese Datei ist die verbindliche technische Referenz für:
|
||||
- Statuscodes
|
||||
- Auth-Header
|
||||
|
||||
## Fehlerhülle (API-Standard)
|
||||
|
||||
Fehlerantworten nutzen ein einheitliches Schema:
|
||||
|
||||
- `ok: false`
|
||||
- `request_id: <uuid>`
|
||||
- `error_code: <stable_machine_code>`
|
||||
- `details: { ... }`
|
||||
- kein Legacy-Feld `error` oder `errors`
|
||||
|
||||
`request_id` wird zusaetzlich als Header `X-Request-Id` geliefert.
|
||||
Die `request_id` kommt zentral aus `RequestContext` und korreliert API-Fehler mit Audit-Einträgen.
|
||||
|
||||
## API-Doku im Admin
|
||||
|
||||
- UI: `/admin/api-docs`
|
||||
|
||||
Reference in New Issue
Block a user