buzzert/Kordophone
Private
Public Access
1
0
Fork 0
Code Packages Activity

Remove API references from READMEs

Browse Source
This commit is contained in:
James Magahern
2025-09-06 19:55:04 -07:00
parent acbcf2f992
commit 27c6ac1c47
3 changed files with 4 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -43,7 +43,7 @@ cd mock
go run ./... # or: make; ./kordophone-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: 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 ## 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. 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.

3
android/README.md
View File

@@ -43,5 +43,4 @@ cd mock
go run ./... # or: make; ./kordophone-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/`).

17
mock/README.md
View File

@@ -22,19 +22,6 @@ Flags:
Listens on `http://localhost:5738` by default. Listens on `http://localhost:5738` by default.
## API Surface (mocked) ## API Compatibility
- `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.
Implements the Kordophone HTTP API used by clients. Refer to the centralized API documentation (planned under `api/`) for the authoritative specification.