diff --git a/apps/api/src/public-api/openapi.ts b/apps/api/src/public-api/openapi.ts index 559ee87..cc0a467 100644 --- a/apps/api/src/public-api/openapi.ts +++ b/apps/api/src/public-api/openapi.ts @@ -251,7 +251,9 @@ export function buildOpenApiDocument(): object { paths: { '/me': { get: { - summary: "The token's user and scope (client smoke test).", + summary: + "The token's user — id, username, display name — plus scope and pond " + + 'restriction. The way to find your own user id (client smoke test).', responses: { '200': jsonResponse('Token identity', ref('Me')) }, }, }, diff --git a/docs/de/manual/api-guide.md b/docs/de/manual/api-guide.md index 6f0150e..4ebb6f2 100644 --- a/docs/de/manual/api-guide.md +++ b/docs/de/manual/api-guide.md @@ -40,8 +40,8 @@ curl -H "Authorization: Bearer dt_pat_..." \ https://wiki.example.com/api/public/v1/me ``` -`GET /me` ist der Smoke-Test — er liefert dein Benutzerkonto, den -Token-Scope und eine etwaige Teich-Beschränkung. +`GET /me` ist der Smoke-Test — er liefert dein Benutzerkonto (samt +deiner User-ID), den Token-Scope und eine etwaige Teich-Beschränkung. ## Lesen diff --git a/docs/manual/api-guide.md b/docs/manual/api-guide.md index d1632f1..d9766ad 100644 --- a/docs/manual/api-guide.md +++ b/docs/manual/api-guide.md @@ -37,8 +37,8 @@ curl -H "Authorization: Bearer dt_pat_..." \ https://wiki.example.com/api/public/v1/me ``` -`GET /me` is the smoke test — it returns your user, the token scope, -and any pond restriction. +`GET /me` is the smoke test — it returns your user (including your +user id), the token scope, and any pond restriction. ## Reading