fa/breadcrumb-the-shire
1
0
Fork 1
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Fix docs drift and unify avatar API error envelope

Browse Source
This commit is contained in:
Felix Schneider
2026-03-24 19:29:47 +01:00
parent 6e35103bea
commit af36583862
7 changed files with 29 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference-api.md
View File

@@ -1,6 +1,6 @@
# REST-API (v1)
Letzte Aktualisierung: 2026-03-06
Letzte Aktualisierung: 2026-03-24
## Single Source of Truth
@@ -46,7 +46,7 @@ Alle fachlichen und technischen API-Details stehen nur in `/docs/openapi.yaml`.
1. API-Änderung immer zuerst in `/docs/openapi.yaml` pflegen.
2. `/admin/api-docs` öffnen und Rendering kurz prüfen.
3. API-Request per Client testen (z. B. Yaak/Postman/cURL).
4. Nur falls nötig hier in `api.md` organisatorische Hinweise ergänzen (keine Endpoint-Details).
4. Nur falls nötig hier in `reference-api.md` organisatorische Hinweise ergänzen (keine Endpoint-Details).
## Verwandte Dokumente

4
docs/reference-entwickler-checkliste.md
View File

@@ -1,6 +1,6 @@
# Entwickler-Checkliste
Letzte Aktualisierung: 2026-03-18
Letzte Aktualisierung: 2026-03-24
## Ziel
@@ -75,7 +75,7 @@ Kurze Definition of Done vor Merge.
- [ ] bei Modul-/Manifest-/Routen-Aenderungen: `APP_ENABLED_MODULES='addressbook,bookmarks' php bin/console module:sync`
- [ ] Runtime-Sync erzeugt Step-Summary (`migrate`, `permissions-sync`, `build`, `assets-sync`) und `vendor_warnings_ignored=<n>`
- [ ] Keine First-party CLI-Warnings/Notices/Deprecations im Runtime-Sync (Vendor-Warnings sind nur temporaer toleriert und muessen gezaehlt sichtbar sein)
- [ ] bei Docs-/Skills-Aenderungen: `docker compose exec php vendor/bin/phpunit tests/Architecture/CodexSkillsContractTest.php`
- [ ] bei Docs-/Skills-Aenderungen: `docker compose exec php vendor/bin/phpunit tests/Architecture/CodexSkillReferenceContractTest.php`
- [ ] bei Docs-/Skills-Aenderungen: `bin/docs-link-check.sh` (scannt standardmaessig ohne `.agents/runs/**`)
- [ ] bei Docs-/Skills-Aenderungen: `bin/codex-skills-sync.sh --check`
- [ ] bei JS-Änderungen: Browser-Smoke mit DevTools-Console (keine JS-Errors)

8
docs/reference-konfiguration.md
View File

@@ -1,6 +1,6 @@
# Konfiguration (ENV-Variablen)
Letzte Aktualisierung: 2026-03-06
Letzte Aktualisierung: 2026-03-24
Alle Konfiguration erfolgt über Umgebungsvariablen in der `.env`-Datei.
Vorlage: `.env.example` — niemals echte Credentials committen.
@@ -11,7 +11,7 @@ Vorlage: `.env.example` — niemals echte Credentials committen.
| Variable | Standard | Beschreibung |
|---|---|---|
| `APP_NAME` | `App` | Anwendungsname (wird in UI-Titeln und E-Mails verwendet) |
| `APP_NAME` | `CoreCore` | Anwendungsname (wird in UI-Titeln und E-Mails verwendet) |
| `APP_URL` | `http://localhost:8080` | Basis-URL der Anwendung (für Links in E-Mails und Redirects) |
| `APP_ENV` | `dev` | Laufzeitumgebung (`dev` oder `prod`) — beeinflusst Fehlerausgabe und Caching |
| `APP_DEBUG` | `true` | Debug-Modus aktivieren (`true`/`false`) — in Produktion auf `false` setzen |
@@ -29,7 +29,7 @@ Vorlage: `.env.example` — niemals echte Credentials committen.
| Variable | Standard | Beschreibung |
|---|---|---|
| `SESSION_NAME` | `app_session` | Name des Session-Cookies im Browser |
| `SESSION_NAME` | `CoreCore` | Name des Session-Cookies im Browser |
---
@@ -85,7 +85,7 @@ Die Firewall begrenzt gleichzeitige Requests pro IP (Concurrency-Schutz).
| `SMTP_USER` | `no-reply@example.com` | SMTP-Benutzername / Absenderadresse |
| `SMTP_PASS` | _(leer)_ | SMTP-Passwort |
| `SMTP_FROM` | `no-reply@example.com` | Absender-E-Mail-Adresse |
| `SMTP_FROM_NAME` | `App` | Absendername in ausgehenden E-Mails |
| `SMTP_FROM_NAME` | `CoreCore` | Absendername in ausgehenden E-Mails |
| `SMTP_SECURE` | `tls` | Verschlüsselungstyp: `tls` (STARTTLS) oder `ssl` |
---

4
docs/reference-konventionen.md
View File

@@ -1,6 +1,6 @@
# Konventionen (kurz und verbindlich)
Letzte Aktualisierung: 2026-03-18
Letzte Aktualisierung: 2026-03-24
## 1) Code
@@ -37,7 +37,7 @@ Letzte Aktualisierung: 2026-03-18
- UUID-first für externe Ressourcen.
- Interne IDs nicht nach außen geben.
- Fehlerantworten einheitlich halten (`error`, optional `errors`).
- Fehlerantworten einheitlich halten (`ok`, `request_id`, `error_code`, `details`; kein Legacy-`error`/`errors`).
- OpenAPI bei jeder API-Änderung im selben Merge aktualisieren.
## 5) Frontend