diff --git a/README.md b/README.md index ec98272..1c91e91 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ cd mock go run ./... # or: make; ./kordophone-mock ``` -The mock server listens on `http://localhost:5738` and serves endpoints like `/conversations`, `/messages`, `/sendMessage`, `/attachment`, `/updates`. +The mock server listens on `http://localhost:5738`. 2) Point a client at the mock server: @@ -77,4 +77,3 @@ The macOS server uses private APIs and restricted entitlements. On production ma ## Contributing Issues and PRs are welcome. If you add a new client or endpoint, please update relevant READMEs and link it from this root README. Prefer small, focused changes and keep style consistent with the existing code. - diff --git a/android/README.md b/android/README.md index 992115f..817fcc0 100644 --- a/android/README.md +++ b/android/README.md @@ -43,5 +43,4 @@ cd mock go run ./... # or: make; ./kordophone-mock ``` -Set the app’s server URL to the mock address and run. The mock exposes `/conversations`, `/messages`, `/sendMessage`, `/attachment`, `/updates` and more. - +Set the app’s server URL to the mock address and run. The mock implements the Kordophone server API; see centralized API documentation (planned under `api/`). diff --git a/mock/README.md b/mock/README.md index f7820cc..09e8331 100644 --- a/mock/README.md +++ b/mock/README.md @@ -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=...` — long‑poll 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.