add api example

cracker0dks · Mar 24, 2024 · 68ccf31 · 68ccf31
1 parent 5a90264
commit 68ccf31
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/scripts/server-backend.js b/scripts/server-backend.js
@@ -208,6 +208,9 @@ export default function startBackendServer(port) {
      *
      * @apiSuccess {String} body returns "done" as text
      * @apiError {Number} 401 Unauthorized
+     * 
+     * @apiExample {curl} Example usage to draw a circle:
+     * curl -i http://[rootUrl]/api/drawToWhiteboard?wid=[MyWhiteboardId]&t=circle&d=[388,201,100]&th=4
      */
     app.get("/api/drawToWhiteboard", function (req, res) {
         let query = escapeAllContentStrings(req["query"]);