From fae83f8d22063cafe1be94d76c5d9a7ea167f129 Mon Sep 17 00:00:00 2001 From: AsamK Date: Thu, 5 Oct 2023 22:18:36 +0200 Subject: [PATCH] Extend json-rpc man page --- man/signal-cli-jsonrpc.5.adoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/man/signal-cli-jsonrpc.5.adoc b/man/signal-cli-jsonrpc.5.adoc index ad9cb538..7f4aeeb3 100644 --- a/man/signal-cli-jsonrpc.5.adoc +++ b/man/signal-cli-jsonrpc.5.adoc @@ -13,7 +13,7 @@ signal-cli-jsonrpc - A commandline and dbus interface for the Signal messenger == Synopsis -*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] daemon [--socket] [--tcp] [--http] +*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] daemon [--socket[=SOCKET_PATH]] [--tcp[=HOST:PORT]] [--http[=HOST:PORT]] *signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] jsonRpc @@ -32,6 +32,12 @@ This is intended to make it easier to embed signal-cli in other applications. `signal-cli -a _ACCOUNT_ daemon --socket` or for multi-account mode `signal-cli daemon --socket` +With `--http` signal-cli exposes three endpoints; + +* POST /api/v1/rpc : Expects a single or batch JSON-RPC request +* GET /api/v1/events : Returns a Server-Sent Events (SSE) stream of incoming messages +* GET /api/v1/check : Responds with 200 OK if daemon is running + == Basic usage In JSON-RPC mode, signal-cli will read requests from stdin. -- 2.50.1