relay/openapi: add note about websocket connection in sync endpoint

weechat · May 19, 2024 · cb08919 · cb08919
1 parent c67eb4e
commit cb08919
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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'