add api example

2024-03-24 23:23:20 +01:00 · 2024-03-24 23:23:20 +01:00 · 68ccf318ca
commit 68ccf318ca
parent 5a902644c1
1 changed files with 3 additions and 0 deletions
--- 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"]);