Skip to content

API docs: WebSocket event catalog & usage guide #440

Description

@codebestia

Write apps/backend/docs/api-websocket-events.md — a usage-oriented guide covering: connection + auth handshake, every inbound event a client can emit (send_message, send_file_message, edit_message, delete_message, message_read, typing_start/typing_stop, join_room, message_history, resume, ask_assistant, etc.) and every outbound event the server emits, each with a realistic example payload and when it fires.

Acceptance criteria:

  • Every event currently handled by the dispatcher/socket layer is documented with an example payload
  • The doc explains the current envelope-wrapper vs. legacy-raw-emit situation as it actually is in the code today
  • ask_assistant's call-out to the AI agent service is documented as part of that event's entry

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions