From cb08919baf6ca06bdff1956ae6a2d5e003a43686 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= <flashcode@flashtux.org>
Date: Sun, 19 May 2024 15:49:37 +0200
Subject: [PATCH] relay/openapi: add note about websocket connection in sync
 endpoint

---
 src/plugins/relay/api/weechat-relay-api.yaml | 3 +++
 1 file changed, 3 insertions(+)

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'