Eigene Identität in der API: prüfen + dokumentieren #147

Closed
opened 2026-07-20 00:15:47 +02:00 by fable-5 · 1 comment
Collaborator

Ziel

Der Weg zur eigenen User-ID ist in der API-Doku klar auffindbar. Befund der Planung: GET /api/v1/auth/me (intern) und GET /api/public/v1/me (PAT; liefert Nutzer + zugängliche Teiche, public-api.controller.ts:71) existieren bereits — der frühere Fehlbefund galt dem Pfad /users/me.

Umsetzungsskizze

  • OpenAPI-Spec (apps/api/src/public-api/openapi.ts) prüfen: ist /me beschrieben, inkl. Hinweis „User-ID hier"? Sonst ergänzen.
  • API-Doku (docs en/de) entsprechend ergänzen.
  • MCP-Parität prüfen: gibt es ein whoami-/me-Tool? Falls nein, ergänzen oder im Issue dokumentieren, warum nicht.
  • KEIN neuer Endpoint, außer beim Doku-Check fällt eine echte Lücke auf.

Akzeptanzkriterien

  • OpenAPI + Doku nennen den Weg zur eigenen User-ID (beide APIs).
  • MCP bietet die Info an oder die bewusste Auslassung ist dokumentiert.
## Ziel Der Weg zur eigenen User-ID ist in der API-Doku klar auffindbar. Befund der Planung: `GET /api/v1/auth/me` (intern) und `GET /api/public/v1/me` (PAT; liefert Nutzer + zugängliche Teiche, `public-api.controller.ts:71`) existieren bereits — der frühere Fehlbefund galt dem Pfad `/users/me`. ## Umsetzungsskizze - OpenAPI-Spec (`apps/api/src/public-api/openapi.ts`) prüfen: ist `/me` beschrieben, inkl. Hinweis „User-ID hier"? Sonst ergänzen. - API-Doku (docs en/de) entsprechend ergänzen. - MCP-Parität prüfen: gibt es ein whoami-/me-Tool? Falls nein, ergänzen oder im Issue dokumentieren, warum nicht. - KEIN neuer Endpoint, außer beim Doku-Check fällt eine echte Lücke auf. ## Akzeptanzkriterien - OpenAPI + Doku nennen den Weg zur eigenen User-ID (beide APIs). - MCP bietet die Info an oder die bewusste Auslassung ist dokumentiert.
fable-5 added this to the M21 — API & Feeds milestone 2026-07-20 00:15:47 +02:00
Author
Collaborator

Befund bestaetigt und umgesetzt in PR #157 (89ffbc0): GET /api/public/v1/me existierte bereits (liefert user.id/username/displayName, Scope, Teich-Beschraenkung) — der fruehere Fehlbefund galt nur dem Pfad /users/me. OpenAPI-Summary nennt jetzt ausdruecklich die User-ID, api-guide en+de ebenso; MCP war bereits paritaetisch. Kein neuer Endpoint noetig.

Befund bestaetigt und umgesetzt in PR #157 (89ffbc0): GET /api/public/v1/me existierte bereits (liefert user.id/username/displayName, Scope, Teich-Beschraenkung) — der fruehere Fehlbefund galt nur dem Pfad /users/me. OpenAPI-Summary nennt jetzt ausdruecklich die User-ID, api-guide en+de ebenso; MCP war bereits paritaetisch. Kein neuer Endpoint noetig.
Sign in to join this conversation.
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: stwaidele/dorfteich#147
No description provided.