doc/user: add relay "api" (issue #2066)

1 files changed, 59 insertions, 10 deletions

diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index 3aa0dd183..4720037e6 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -36,7 +36,8 @@ WeeChat (Wee Enhanced Environment for Chat)
   https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^]、
   https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^]、
   https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]。
-* リモートインターフェース用の IRC プロキシとリレー
+// TRANSLATION MISSING
+* IRC proxy and relay for WeeChat and remote interfaces
 * マルチプラットフォーム (GNU/Linux、*BSD、macOS、Windows 等)
 * 完全な GPL、フリーソフトウェア
 
@@ -144,7 +145,8 @@ WeeChat:
 // TRANSLATION MISSING
 | zlib1g-dev |
 | Logger plugin: compression of rotated log files (gzip). +
-  Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^] (weechat protocol). +
+  Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^]
+  (api and weechat protocols). +
   Script plugin: read of repository index file (gzip).
 |===
 
@@ -180,7 +182,8 @@ WeeChat:
 // TRANSLATION MISSING
 | libzstd-dev | ≥ 0.8.1
 | Logger plugin: compression of rotated log files (zstandard). +
-  Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat protocol).
+  Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^]
+  (api and weechat protocols).
 
 | libaspell-dev / libenchant-dev |
 | spell プラグイン
@@ -4752,8 +4755,15 @@ Relay プラグインはネットワークを介して異なるプロトコル�
 * _irc_: IRC プロキシ: IRC サーバに対する接続を、単一または複数の IRC
   クライアントで共有するために用います。
 // TRANSLATION MISSING
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+  interact with WeeChat
+// TRANSLATION MISSING
 * _weechat_: protocol used by remote interfaces to display and interact with
-  WeeChat, see https://weechat.org/about/interfaces/[this page ^↗^^].
+  WeeChat.
+
+// TRANSLATION MISSING
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
 
 [[relay_password]]
 === パスワード
@@ -4766,13 +4776,15 @@ secure set relay mypassword
 /set relay.network.password "${sec.data.relay}"
 ----
 
-このパスワードは _irc_ と _weechat_ プロトコルで利用されます。
+// TRANSLATION MISSING
+This password is used with all protocols.
 
 [[relay_totp]]
 === TOTP
 
-_weechat_ プロトコルでは、パスワードに加えて、二要素認証の
-TOTP (時間ベースのワンタイムパスワード) を使うことが可能です。
+// TRANSLATION MISSING
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _api_ and _weechat_ protocols, in addition to the password.
 
 これは任意設定項目であり、セキュリティレベルを向上させます。
 
@@ -4869,6 +4881,40 @@ commands:
 /set irc.server.relay.password "${sec.data.relay_libera}"
 ----
 
+// TRANSLATION MISSING
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
 [[relay_weechat_protocol]]
 === WeeChat プロトコル
 
@@ -4908,8 +4954,11 @@ HTML5 を使えばたった 1 行の JavaScript で WebSocket をオープンす
 websocket = new WebSocket("ws://server.com:9000/weechat");
 ----
 
-ポート番号 (例では 9000 番) は Relay プラグインで定義したものです。URI
-の最後には必ず "/weechat" をつけます (_irc_ と _weechat_ プロトコルの場合)。
+ポート番号 (例では 9000 番) は Relay プラグインで定義したものです。
+
+// TRANSLATION MISSING
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
 
 [[relay_unix_socket]]
 === UNIX ドメインソケット
@@ -4952,7 +5001,7 @@ _relay.conf_ ファイル内のセクション:
 | network    | /set relay.network.*               | ネットワークオプション
 | irc        | /set relay.irc.*                   | 特定の irc プロトコルのオプション (irc プロキシ)
 | port       | <<command_relay_relay,/relay add>> +
-               /set relay.port.*                  | リレーに使うポート(irc や weechat プロトコル) (オプションをセクションに追加/削除出来ます)
+               /set relay.port.*                  | リレーに使うポート (オプションをセクションに追加/削除出来ます)
 |===
 
 オプション: