From 8422dadcc59c643fcde82516c095b7391866751c Mon Sep 17 00:00:00 2001
From: Ben Arc <ben@arc.wales>
Date: Tue, 20 Apr 2021 10:45:54 +0100
Subject: [PATCH] added docs for ws api point

---
 .../copilot/templates/copilot/_api_docs.html  | 23 +++++++++++++++++++
 lnbits/extensions/copilot/views_api.py        |  2 +-
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/lnbits/extensions/copilot/templates/copilot/_api_docs.html b/lnbits/extensions/copilot/templates/copilot/_api_docs.html
index 60bc901ba..048458195 100644
--- a/lnbits/extensions/copilot/templates/copilot/_api_docs.html
+++ b/lnbits/extensions/copilot/templates/copilot/_api_docs.html
@@ -142,5 +142,28 @@
         </q-card-section>
       </q-card>
     </q-expansion-item>
+    <q-expansion-item
+      group="api"
+      dense
+      expand-separator
+      label="Trigger an animation"
+      class="q-pb-md"
+    >
+      <q-card>
+        <q-card-section>
+          <code
+            ><span class="text-blue">GET</span>
+            /api/v1/copilot/ws/&lt;copilot_id&gt;/&lt;comment&gt;/&lt;data&gt;</code
+          >
+          <h5 class="text-caption q-mt-sm q-mb-none">Returns 200</h5>
+          <code></code>
+          <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
+          <code
+            >curl -X GET {{ request.url_root }}/api/v1/copilot/ws/&lt;string,
+            copilot_id&gt;/&lt;string, comment&gt;/&lt;string, gif name&gt;
+          </code>
+        </q-card-section>
+      </q-card>
+    </q-expansion-item>
   </q-expansion-item>
 </q-card>
diff --git a/lnbits/extensions/copilot/views_api.py b/lnbits/extensions/copilot/views_api.py
index 2b820a4be..bca40f86b 100644
--- a/lnbits/extensions/copilot/views_api.py
+++ b/lnbits/extensions/copilot/views_api.py
@@ -95,7 +95,7 @@ async def api_copilot_delete(copilot_id):
 
 
 @copilot_ext.route("/api/v1/copilot/ws/<copilot_id>/<comment>/<data>", methods=["GET"])
-async def api_copilot_retrieve(copilot_id, comment, data):
+async def api_copilot_ws_relay(copilot_id, comment, data):
     copilot = await get_copilot(copilot_id)
 
     if not copilot: