added API controller endpoint documentation for makebackup

2024-01-18 11:12:31 -07:00
parent a02bcf94d7
commit 0bfa036603
2 changed files with 31 additions and 1 deletions
--- a/Views/API/Index.cshtml
+++ b/Views/API/Index.cshtml
@@ -124,4 +124,21 @@
    <div class="col-3">
        vehicleId - Id of Vehicle
    </div>
-</div>
+</div>
+@if (User.IsInRole(nameof(UserData.IsRootUser)))
+{
+    <div class="row">
+        <div class="col-1">
+            GET
+        </div>
+        <div class="col-5">
+            <code>/api/makebackup</code>
+        </div>
+        <div class="col-3">
+            Creates a snapshot/backup of the DB at the time and returns a URL to download it.
+        </div>
+        <div class="col-3">
+            No Params(must be root user)
+        </div>
+    </div>
+}