Restore improvement: transfers swagger (#4063)

* fix(makefile): use sctool.dev in make docs

This was overlooked when deleting the sctool file in db466ef.

* fix(docs): backup, generate docs for --skip-schema

This was overlooked when the --skip-schema flag was introduced in 90eb17d.

* feat(swagger): agent, add /rclone/operations/set-transfers endpoint

This endpoint will be used to control the amount of transfers during backup/restore.

Makefile

@@ -226,7 +226,7 @@ build: build-cli build-agent build-server ## Build all project binaries
 docs: export TZ = UTC ## set UTC as the default timezone in generated docs
 docs: build ## Update docs/source with generated code
 	@rm -rf docs/source/sctool/partials
-	@SCYLLA_MANAGER_CLUSTER="" ./sctool doc -o docs/source/sctool/partials
+	@SCYLLA_MANAGER_CLUSTER="" ./sctool.dev doc -o docs/source/sctool/partials
 
 .PHONY: filler-tool
 filler-tool: ## Build "filler" tool

docs/source/sctool/partials/sctool_backup.yaml

@@ -125,6 +125,14 @@ options:
       default_value: "false"
       usage: |
         Prints table names together with keyspace, used in combination with --dry-run.
+    - name: skip-schema
+      default_value: "false"
+      usage: |
+        Don't backup schema.
+        For ScyllaDB versions starting at 6.0 and 2024.2, SM requires CQL credentials to back up the schema.
+        CQL Credentials can be added with 'sctool cluster update --username --password' command.
+        This flag can be used to skip this step and allow for backing up user data without providing SM with CQL credentials.
+        Note that it's impossible to restore schema from such backups.
     - name: snapshot-parallel
       default_value: '[]'
       usage: |

docs/source/sctool/partials/sctool_backup_update.yaml

@@ -126,6 +126,14 @@ options:
       default_value: "false"
       usage: |
         Prints table names together with keyspace, used in combination with --dry-run.
+    - name: skip-schema
+      default_value: "false"
+      usage: |
+        Don't backup schema.
+        For ScyllaDB versions starting at 6.0 and 2024.2, SM requires CQL credentials to back up the schema.
+        CQL Credentials can be added with 'sctool cluster update --username --password' command.
+        This flag can be used to skip this step and allow for backing up user data without providing SM with CQL credentials.
+        Note that it's impossible to restore schema from such backups.
     - name: snapshot-parallel
       default_value: '[]'
       usage: |

v3/swagger/agent.json

@@ -19,7 +19,7 @@
   "paths": {
     "/rclone/core/bwlimit": {
       "post": {
-        "description": "This sets the bandwidth limit to that passed in",
+        "description": "This sets the bandwidth limit to that passed in. If the rate parameter is not supplied then the bandwidth is queried",
         "summary": "Set the bandwidth limit",
         "operationId": "CoreBwlimit",
         "produces": [
@@ -54,6 +54,43 @@
         "security": []
       }
     },
+    "/rclone/core/transfers": {
+      "post": {
+        "description": "This sets the default amount of transfers to that passed in. If the transfers parameter is not supplied then the transfers are queried",
+        "summary": "Set transfers",
+        "operationId": "CoreTransfers",
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "transfers",
+            "description": "transfers",
+            "schema": {
+              "$ref": "#/definitions/Transfers"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "transfers",
+            "schema": {
+              "$ref": "#/definitions/Transfers"
+            },
+            "headers": {}
+          },
+          "default": {
+            "description": "Server error",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            },
+            "headers": {}
+          }
+        },
+        "security": []
+      }
+    },
     "/rclone/core/stats-reset": {
       "post": {
         "description": "Resets stats",
@@ -875,6 +912,16 @@
         }
       }
     },
+    "Transfers": {
+      "title": "transfers",
+      "type": "object",
+      "properties": {
+        "transfers": {
+          "description": "The number of file transfers to run in parallel",
+          "type": "integer"
+        }
+      }
+    },
     "Jobid": {
       "type": "object",
       "properties": {