fix: module variable http api docs

bitfocus · Feb 5, 2025 · 0eef38d · 0eef38d
1 parent 84aa5f7
commit 0eef38d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/5_remote_control/http_remote_control.md b/docs/5_remote_control/http_remote_control.md
@@ -55,9 +55,9 @@ This API tries to follow REST principles, and the convention that a `POST` reque
 - Get custom variable value  
   Method: GET  
   Path: `/api/custom-variable/<name>/value`
-- Get Module variable value
-  Method: GET
-  Path: `/api/variable/<Connection Label>/<name>/value`
+- Get Module variable value  
+  Method: GET  
+  Path: `/api/variable/<Connection Label>/<name>/value`  
 - Rescan for USB surfaces  
   Method: POST  
   Path: `/api/surfaces/rescan`  

diff --git a/webui/src/UserConfig/HttpProtocol.tsx b/webui/src/UserConfig/HttpProtocol.tsx
@@ -120,6 +120,13 @@ export function HttpProtocol() {
 					<br />
 					Path: <code>/api/custom-variable/</code>&lt;name&gt;<code>/value</code>
 				</li>
+				<li>
+					Get Module variable value
+					<br />
+					Method: <code>GET</code>
+					<br />
+					Path: <code>/api/variable/</code>&lt;Connection label&gt;<code>/</code>&lt;name&gt;<code>/value</code>
+				</li>
 				<li>
 					Make Companion rescan for newly attached USB surfaces
 					<br />