added docs for ws api point
This commit is contained in:
parent
25c2d2c7c6
commit
8422dadcc5
2 changed files with 24 additions and 1 deletions
|
|
@ -142,5 +142,28 @@
|
||||||
</q-card-section>
|
</q-card-section>
|
||||||
</q-card>
|
</q-card>
|
||||||
</q-expansion-item>
|
</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/<copilot_id>/<comment>/<data></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/<string,
|
||||||
|
copilot_id>/<string, comment>/<string, gif name>
|
||||||
|
</code>
|
||||||
|
</q-card-section>
|
||||||
|
</q-card>
|
||||||
|
</q-expansion-item>
|
||||||
</q-expansion-item>
|
</q-expansion-item>
|
||||||
</q-card>
|
</q-card>
|
||||||
|
|
|
||||||
|
|
@ -95,7 +95,7 @@ async def api_copilot_delete(copilot_id):
|
||||||
|
|
||||||
|
|
||||||
@copilot_ext.route("/api/v1/copilot/ws/<copilot_id>/<comment>/<data>", methods=["GET"])
|
@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)
|
copilot = await get_copilot(copilot_id)
|
||||||
|
|
||||||
if not copilot:
|
if not copilot:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue