summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2024-05-19 15:49:37 +0200
committerSébastien Helleu <flashcode@flashtux.org>2024-05-19 15:49:37 +0200
commitcb08919baf6ca06bdff1956ae6a2d5e003a43686 (patch)
tree7010aa09a007992a8e4800fcca2d0f9f3650ea90
parentc67eb4e656dbe8877d4be9b93f576a3a2a4e6492 (diff)
downloadweechat-cb08919baf6ca06bdff1956ae6a2d5e003a43686.zip
relay/openapi: add note about websocket connection in sync endpoint
-rw-r--r--src/plugins/relay/api/weechat-relay-api.yaml3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/plugins/relay/api/weechat-relay-api.yaml b/src/plugins/relay/api/weechat-relay-api.yaml
index ba3e9aaa2..35aa1779b 100644
--- a/src/plugins/relay/api/weechat-relay-api.yaml
+++ b/src/plugins/relay/api/weechat-relay-api.yaml
@@ -403,6 +403,9 @@ paths:
- sync
description: |
Synchronize with WeeChat.
+
+ This endpoint can only be used when connected via websocket: WeeChat
+ will then push messages to the client at any time.
operationId: sync
parameters:
- $ref: '#/components/parameters/totp'