From 68ccf318ca86b94469db96ad305ce02b142b64d8 Mon Sep 17 00:00:00 2001 From: Raphael Date: Sun, 24 Mar 2024 23:23:20 +0100 Subject: [PATCH] add api example --- scripts/server-backend.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/server-backend.js b/scripts/server-backend.js index 73c231e..0747cc2 100644 --- 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"]);