fz-mirrors/AstrBot
1
0
Fork 0
mirror of https://github.com/AstrBotDevs/AstrBot synced 2026-07-16 01:40:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify OpenAPI chat username identity (#8880)

Browse Source
This commit is contained in:
Weilong Liao
2026-06-18 23:17:50 +08:00
committed by GitHub
parent 1a9d1f566d
commit 49b86320cb
5 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/dev/openapi.md
View File

@@ -130,6 +130,8 @@ Notes:
`POST /api/v1/chat` additionally requires `username`, with optional `session_id` (a UUID is auto-generated if omitted).
`username` is a caller-declared WebChat identity. It is used as the message sender and session owner in the message pipeline, including sender-ID-based command permission checks. Treat API keys with the `chat` scope as trusted backend credentials. If you expose chat access to end users, proxy requests through your own service and map each external user to an allowed `username`; do not let clients submit administrator IDs or other reserved sender IDs directly.
```json
{
"username": "alice",