Private
Public Access
1
0

Remove API references from READMEs

This commit is contained in:
2025-09-06 19:55:04 -07:00
parent acbcf2f992
commit 27c6ac1c47
3 changed files with 4 additions and 19 deletions

View File

@@ -22,19 +22,6 @@ Flags:
Listens on `http://localhost:5738` by default.
## API Surface (mocked)
- `GET /version` — server version
- `GET /status` — status (requires auth when enabled)
- `GET /conversations` — list conversations
- `GET /messages?guid=...&beforeDate=...&beforeMessageGUID=...&afterMessageGUID=...&limit=...` — list messages
- `POST /authenticate` — exchange username/password for a bearer token (when `--auth`)
- `POST /sendMessage` — send a message
- `POST /markConversation?guid=...` — mark read
- `GET /attachment?guid=...` — download attachment
- `POST /uploadAttachment?filename=...` — upload attachment
- `GET /pollUpdates?seq=...` — longpoll for updates
- `GET /updates` — WebSocket updates
Note: `/api/*` paths are redirected to the same endpoints for compatibility.
## API Compatibility
Implements the Kordophone HTTP API used by clients. Refer to the centralized API documentation (planned under `api/`) for the authoritative specification.