rclone-openapi 1.0.16 → 1.0.18

package/openapi.json

@@ -1835,6 +1835,36 @@
         "operationId": "coreStats"
       }
     },
+    "/job/batch": {
+      "post": {
+        "summary": "Run batch of commands",
+        "description": "Run a batch of rclone rc commands concurrently.",
+        "tags": [],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/Job_BatchPostConcurrencyParam"
+          },
+          {
+            "$ref": "#/components/parameters/Job_BatchPostInputsParam"
+          },
+          {
+            "$ref": "#/components/parameters/GlobalAsyncParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/JobBatchResponse"
+          },
+          "4XX": {
+            "$ref": "#/components/responses/RcError"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/RcError"
+          }
+        },
+        "operationId": "jobBatch"
+      }
+    },
     "/job/list": {
       "post": {
         "summary": "List jobs",
@@ -3301,6 +3331,35 @@
         "style": "form",
         "explode": true
       },
+      "Job_BatchPostConcurrencyParam": {
+        "name": "concurrency",
+        "in": "query",
+        "description": "Do this many commands concurrently. Defaults to --transfers if not set.",
+        "schema": {
+          "type": "integer"
+        }
+      },
+      "Job_BatchPostInputsParam": {
+        "name": "inputs",
+        "in": "query",
+        "description": "List of inputs to the commands with an extra _path parameter.",
+        "schema": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "_path"
+            ],
+            "properties": {
+              "_path": {
+                "type": "string",
+                "description": "rc/path"
+              }
+            },
+            "additionalProperties": true
+          }
+        }
+      },
       "Operations_CleanupPostFsParam": {
         "name": "fs",
         "in": "query",
@@ -3956,7 +4015,7 @@
         "required": true
       },
       "Config_UnlockPostConfigPasswordParam": {
-        "name": "config_password",
+        "name": "configPassword",
         "in": "query",
         "description": "Password used to unlock an encrypted config file.",
         "schema": {
@@ -5326,6 +5385,25 @@
           }
         }
       },
+      "JobBatchResponse": {
+        "description": "Results of the batch job execution.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "results": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "additionalProperties": true
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "EmptyResponse": {
         "description": "Request succeeded with no response body."
       },
@@ -5973,6 +6051,18 @@
                   "type": "string",
                   "description": "Go toolchain version used to build rclone."
                 },
+                "osVersion": {
+                  "type": "string",
+                  "description": "OS Version (e.g. ubuntu 24.04 (64 bit))."
+                },
+                "osKernel": {
+                  "type": "string",
+                  "description": "OS Kernel version (e.g. 6.8.0-86-generic (x86_64))."
+                },
+                "osArch": {
+                  "type": "string",
+                  "description": "CPU architecture in use (e.g. arm64 (ARMv8 compatible))."
+                },
                 "linking": {
                   "type": "string",
                   "description": "Linking mode for the binary (static or dynamic)."
@@ -6126,11 +6216,27 @@
                     "type": "number"
                   },
                   "description": "Job IDs suitable for use with `job/status` and `job/stop`."
+                },
+                "runningIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  },
+                  "description": "Array of integer job ids that are running."
+                },
+                "finishedIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  },
+                  "description": "Array of integer job ids that are finished."
                 }
               },
               "required": [
                 "executeId",
-                "jobids"
+                "jobids",
+                "runningIds",
+                "finishedIds"
               ]
             }
           }
@@ -6153,7 +6259,7 @@
                 },
                 "endTime": {
                   "type": "string",
-                  "description": "Timestamp when the job finished."
+                  "description": "Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00')"
                 },
                 "error": {
                   "type": "string",
@@ -6165,7 +6271,7 @@
                 },
                 "startTime": {
                   "type": "string",
-                  "description": "Timestamp when the job started."
+                  "description": "Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00')"
                 },
                 "success": {
                   "type": "boolean",
@@ -7689,8 +7795,14 @@
             "type": "boolean"
           },
           "MetadataInfo": {
-            "$ref": "#/components/schemas/ConfigProviderMetadataInfo",
-            "nullable": true
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/ConfigProviderMetadataInfo"
+              },
+              {
+                "type": "null"
+              }
+            ]
           },
           "Name": {
             "type": "string"
@@ -8022,9 +8134,11 @@
           {
             "type": "object",
             "additionalProperties": true
+          },
+          {
+            "type": "null"
           }
-        ],
-        "nullable": true
+        ]
       },
       "ConfigProviderOptionType": {
         "type": "string",

package/openapi.yaml

@@ -1018,6 +1018,23 @@ paths:
         "5XX":
           $ref: "#/components/responses/RcError"
       operationId: coreStats
+  /job/batch:
+    post:
+      summary: "Run batch of commands"
+      description: "Run a batch of rclone rc commands concurrently."
+      tags: []
+      parameters:
+        - $ref: "#/components/parameters/Job_BatchPostConcurrencyParam"
+        - $ref: "#/components/parameters/Job_BatchPostInputsParam"
+        - $ref: "#/components/parameters/GlobalAsyncParam"
+      responses:
+        "200":
+          $ref: "#/components/responses/JobBatchResponse"
+        "4XX":
+          $ref: "#/components/responses/RcError"
+        "5XX":
+          $ref: "#/components/responses/RcError"
+      operationId: jobBatch
   /job/list:
     post:
       summary: "List jobs"
@@ -1803,6 +1820,27 @@ components:
         type: object
       style: form
       explode: true
+    Job_BatchPostConcurrencyParam:
+      name: concurrency
+      in: query
+      description: "Do this many commands concurrently. Defaults to --transfers if not set."
+      schema:
+        type: integer
+    Job_BatchPostInputsParam:
+      name: inputs
+      in: query
+      description: "List of inputs to the commands with an extra _path parameter."
+      schema:
+        type: array
+        items:
+          type: object
+          required:
+            - _path
+          properties:
+            _path:
+              type: string
+              description: "rc/path"
+          additionalProperties: true
     Operations_CleanupPostFsParam:
       name: fs
       in: query
@@ -2308,7 +2346,7 @@ components:
         type: string
       required: true
     Config_UnlockPostConfigPasswordParam:
-      name: config_password
+      name: configPassword
       in: query
       description: "Password used to unlock an encrypted config file."
       schema:
@@ -3078,6 +3116,18 @@ components:
         application/json:
           schema:
             $ref: "#/components/schemas/RcError"
+    JobBatchResponse:
+      description: "Results of the batch job execution."
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              results:
+                type: array
+                items:
+                  type: object
+                  additionalProperties: true
     EmptyResponse:
       description: "Request succeeded with no response body."
     EmptyObjectResponse:
@@ -3503,6 +3553,15 @@ components:
               goVersion:
                 type: string
                 description: "Go toolchain version used to build rclone."
+              osVersion:
+                type: string
+                description: "OS Version (e.g. ubuntu 24.04 (64 bit))."
+              osKernel:
+                type: string
+                description: "OS Kernel version (e.g. 6.8.0-86-generic (x86_64))."
+              osArch:
+                type: string
+                description: "CPU architecture in use (e.g. arm64 (ARMv8 compatible))."
               linking:
                 type: string
                 description: "Linking mode for the binary (static or dynamic)."
@@ -3615,9 +3674,21 @@ components:
                 items:
                   type: number
                 description: "Job IDs suitable for use with `job/status` and `job/stop`."
+              runningIds:
+                type: array
+                items:
+                  type: integer
+                description: "Array of integer job ids that are running."
+              finishedIds:
+                type: array
+                items:
+                  type: integer
+                description: "Array of integer job ids that are finished."
             required:
               - executeId
               - jobids
+              - runningIds
+              - finishedIds
     JobStatusResponse:
       description: "Detailed status for a background job, including timing, success flag, and optional output."
       content:
@@ -3633,7 +3704,7 @@ components:
                 description: "Execution time in seconds."
               endTime:
                 type: string
-                description: "Timestamp when the job finished."
+                description: "Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00')"
               error:
                 type: string
                 description: "Error message, or empty string on success."
@@ -3642,7 +3713,7 @@ components:
                 description: "Job identifier."
               startTime:
                 type: string
-                description: "Timestamp when the job started."
+                description: "Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00')"
               success:
                 type: boolean
                 description: "True if the job completed successfully."
@@ -4686,8 +4757,9 @@ components:
         Hide:
           type: boolean
         MetadataInfo:
-          $ref: "#/components/schemas/ConfigProviderMetadataInfo"
-          nullable: true
+          anyOf:
+            - $ref: "#/components/schemas/ConfigProviderMetadataInfo"
+            - type: "null"
         Name:
           type: string
         Options:
@@ -4909,7 +4981,7 @@ components:
           items: {}
         - type: object
           additionalProperties: true
-      nullable: true
+        - type: "null"
     ConfigProviderOptionType:
       type: string
       enum:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rclone-openapi",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "keywords": [
     "rclone",
     "openapi",

package/types.d.ts

@@ -1100,6 +1100,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/job/batch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Run batch of commands
+         * @description Run a batch of rclone rc commands concurrently.
+         */
+        post: operations["jobBatch"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/job/list": {
         parameters: {
             query?: never;
@@ -1898,7 +1918,7 @@ export interface components {
             CommandHelp?: components["schemas"]["ConfigProviderCommandHelp"][] | null;
             Description: string;
             Hide?: boolean;
-            MetadataInfo?: components["schemas"]["ConfigProviderMetadataInfo"];
+            MetadataInfo?: components["schemas"]["ConfigProviderMetadataInfo"] | null;
             Name: string;
             Options: components["schemas"]["ConfigProviderOption"][];
             Prefix: string;
@@ -1993,9 +2013,9 @@ export interface components {
             [key: string]: unknown;
         };
         /** @description Arbitrary JSON value. */
-        ConfigProviderOptionAny: (string | number | boolean | unknown[] | {
+        ConfigProviderOptionAny: string | number | boolean | unknown[] | {
             [key: string]: unknown;
-        }) | null;
+        } | null;
         /** @enum {string} */
         ConfigProviderOptionType: "Bits" | "bool" | "CommaSepList" | "Duration" | "Encoding" | "int" | "mtime|atime|btime|ctime" | "SizeSuffix" | "SpaceSepList" | "string" | "stringArray" | "Time" | "Tristate";
         /** @description Progress metrics for an in-flight transfer. */
@@ -2039,6 +2059,19 @@ export interface components {
                 "application/json": components["schemas"]["RcError"];
             };
         };
+        /** @description Results of the batch job execution. */
+        JobBatchResponse: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    results?: {
+                        [key: string]: unknown;
+                    }[];
+                };
+            };
+        };
         /** @description Request succeeded with no response body. */
         EmptyResponse: {
             headers: {
@@ -2389,6 +2422,12 @@ export interface components {
                     isBeta: boolean;
                     /** @description Go toolchain version used to build rclone. */
                     goVersion: string;
+                    /** @description OS Version (e.g. ubuntu 24.04 (64 bit)). */
+                    osVersion?: string;
+                    /** @description OS Kernel version (e.g. 6.8.0-86-generic (x86_64)). */
+                    osKernel?: string;
+                    /** @description CPU architecture in use (e.g. arm64 (ARMv8 compatible)). */
+                    osArch?: string;
                     /** @description Linking mode for the binary (static or dynamic). */
                     linking: string;
                     /** @description Space separated Go build tags, if any. */
@@ -2442,6 +2481,10 @@ export interface components {
                     executeId: string;
                     /** @description Job IDs suitable for use with `job/status` and `job/stop`. */
                     jobids: number[];
+                    /** @description Array of integer job ids that are running. */
+                    runningIds: number[];
+                    /** @description Array of integer job ids that are finished. */
+                    finishedIds: number[];
                 };
             };
         };
@@ -2456,13 +2499,13 @@ export interface components {
                     finished: boolean;
                     /** @description Execution time in seconds. */
                     duration: number;
-                    /** @description Timestamp when the job finished. */
+                    /** @description Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00') */
                     endTime: string;
                     /** @description Error message, or empty string on success. */
                     error: string;
                     /** @description Job identifier. */
                     id: number;
-                    /** @description Timestamp when the job started. */
+                    /** @description Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00') */
                     startTime: string;
                     /** @description True if the job completed successfully. */
                     success: boolean;
@@ -3048,6 +3091,15 @@ export interface components {
         GlobalGroupParam: string;
         /** @description Additional arbitrary parameters allowed. */
         Rc_NoopPostAdditionalParam: Record<string, never>;
+        /** @description Do this many commands concurrently. Defaults to --transfers if not set. */
+        Job_BatchPostConcurrencyParam: number;
+        /** @description List of inputs to the commands with an extra _path parameter. */
+        Job_BatchPostInputsParam: ({
+            /** @description rc/path */
+            _path: string;
+        } & {
+            [key: string]: unknown;
+        })[];
         /** @description Remote name or path to clean up, for example `drive:`. */
         Operations_CleanupPostFsParam: string;
         /** @description Source remote name or path, such as `drive:` or `/` for the local filesystem. */
@@ -4692,7 +4744,7 @@ export interface operations {
         parameters: {
             query: {
                 /** @description Password used to unlock an encrypted config file. */
-                config_password: components["parameters"]["Config_UnlockPostConfigPasswordParam"];
+                configPassword: components["parameters"]["Config_UnlockPostConfigPasswordParam"];
                 /** @description Assign the request to a custom stats group. */
                 _group?: components["parameters"]["GlobalGroupParam"];
                 /** @description Run the command asynchronously. Returns a job id immediately. */
@@ -4776,6 +4828,27 @@ export interface operations {
             "5XX": components["responses"]["RcError"];
         };
     };
+    jobBatch: {
+        parameters: {
+            query?: {
+                /** @description Do this many commands concurrently. Defaults to --transfers if not set. */
+                concurrency?: components["parameters"]["Job_BatchPostConcurrencyParam"];
+                /** @description List of inputs to the commands with an extra _path parameter. */
+                inputs?: components["parameters"]["Job_BatchPostInputsParam"];
+                /** @description Run the command asynchronously. Returns a job id immediately. */
+                _async?: components["parameters"]["GlobalAsyncParam"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: components["responses"]["JobBatchResponse"];
+            "4XX": components["responses"]["RcError"];
+            "5XX": components["responses"]["RcError"];
+        };
+    };
     jobList: {
         parameters: {
             query?: {