rclone-openapi 1.0.17 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/openapi.json CHANGED
@@ -1835,6 +1835,36 @@
1835
1835
  "operationId": "coreStats"
1836
1836
  }
1837
1837
  },
1838
+ "/job/batch": {
1839
+ "post": {
1840
+ "summary": "Run batch of commands",
1841
+ "description": "Run a batch of rclone rc commands concurrently.",
1842
+ "tags": [],
1843
+ "parameters": [
1844
+ {
1845
+ "$ref": "#/components/parameters/Job_BatchPostConcurrencyParam"
1846
+ },
1847
+ {
1848
+ "$ref": "#/components/parameters/Job_BatchPostInputsParam"
1849
+ },
1850
+ {
1851
+ "$ref": "#/components/parameters/GlobalAsyncParam"
1852
+ }
1853
+ ],
1854
+ "responses": {
1855
+ "200": {
1856
+ "$ref": "#/components/responses/JobBatchResponse"
1857
+ },
1858
+ "4XX": {
1859
+ "$ref": "#/components/responses/RcError"
1860
+ },
1861
+ "5XX": {
1862
+ "$ref": "#/components/responses/RcError"
1863
+ }
1864
+ },
1865
+ "operationId": "jobBatch"
1866
+ }
1867
+ },
1838
1868
  "/job/list": {
1839
1869
  "post": {
1840
1870
  "summary": "List jobs",
@@ -3301,6 +3331,35 @@
3301
3331
  "style": "form",
3302
3332
  "explode": true
3303
3333
  },
3334
+ "Job_BatchPostConcurrencyParam": {
3335
+ "name": "concurrency",
3336
+ "in": "query",
3337
+ "description": "Do this many commands concurrently. Defaults to --transfers if not set.",
3338
+ "schema": {
3339
+ "type": "integer"
3340
+ }
3341
+ },
3342
+ "Job_BatchPostInputsParam": {
3343
+ "name": "inputs",
3344
+ "in": "query",
3345
+ "description": "List of inputs to the commands with an extra _path parameter.",
3346
+ "schema": {
3347
+ "type": "array",
3348
+ "items": {
3349
+ "type": "object",
3350
+ "required": [
3351
+ "_path"
3352
+ ],
3353
+ "properties": {
3354
+ "_path": {
3355
+ "type": "string",
3356
+ "description": "rc/path"
3357
+ }
3358
+ },
3359
+ "additionalProperties": true
3360
+ }
3361
+ }
3362
+ },
3304
3363
  "Operations_CleanupPostFsParam": {
3305
3364
  "name": "fs",
3306
3365
  "in": "query",
@@ -3956,7 +4015,7 @@
3956
4015
  "required": true
3957
4016
  },
3958
4017
  "Config_UnlockPostConfigPasswordParam": {
3959
- "name": "config_password",
4018
+ "name": "configPassword",
3960
4019
  "in": "query",
3961
4020
  "description": "Password used to unlock an encrypted config file.",
3962
4021
  "schema": {
@@ -5326,6 +5385,25 @@
5326
5385
  }
5327
5386
  }
5328
5387
  },
5388
+ "JobBatchResponse": {
5389
+ "description": "Results of the batch job execution.",
5390
+ "content": {
5391
+ "application/json": {
5392
+ "schema": {
5393
+ "type": "object",
5394
+ "properties": {
5395
+ "results": {
5396
+ "type": "array",
5397
+ "items": {
5398
+ "type": "object",
5399
+ "additionalProperties": true
5400
+ }
5401
+ }
5402
+ }
5403
+ }
5404
+ }
5405
+ }
5406
+ },
5329
5407
  "EmptyResponse": {
5330
5408
  "description": "Request succeeded with no response body."
5331
5409
  },
@@ -5973,6 +6051,18 @@
5973
6051
  "type": "string",
5974
6052
  "description": "Go toolchain version used to build rclone."
5975
6053
  },
6054
+ "osVersion": {
6055
+ "type": "string",
6056
+ "description": "OS Version (e.g. ubuntu 24.04 (64 bit))."
6057
+ },
6058
+ "osKernel": {
6059
+ "type": "string",
6060
+ "description": "OS Kernel version (e.g. 6.8.0-86-generic (x86_64))."
6061
+ },
6062
+ "osArch": {
6063
+ "type": "string",
6064
+ "description": "CPU architecture in use (e.g. arm64 (ARMv8 compatible))."
6065
+ },
5976
6066
  "linking": {
5977
6067
  "type": "string",
5978
6068
  "description": "Linking mode for the binary (static or dynamic)."
@@ -6126,11 +6216,27 @@
6126
6216
  "type": "number"
6127
6217
  },
6128
6218
  "description": "Job IDs suitable for use with `job/status` and `job/stop`."
6219
+ },
6220
+ "runningIds": {
6221
+ "type": "array",
6222
+ "items": {
6223
+ "type": "integer"
6224
+ },
6225
+ "description": "Array of integer job ids that are running."
6226
+ },
6227
+ "finishedIds": {
6228
+ "type": "array",
6229
+ "items": {
6230
+ "type": "integer"
6231
+ },
6232
+ "description": "Array of integer job ids that are finished."
6129
6233
  }
6130
6234
  },
6131
6235
  "required": [
6132
6236
  "executeId",
6133
- "jobids"
6237
+ "jobids",
6238
+ "runningIds",
6239
+ "finishedIds"
6134
6240
  ]
6135
6241
  }
6136
6242
  }
@@ -6153,7 +6259,7 @@
6153
6259
  },
6154
6260
  "endTime": {
6155
6261
  "type": "string",
6156
- "description": "Timestamp when the job finished."
6262
+ "description": "Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00')"
6157
6263
  },
6158
6264
  "error": {
6159
6265
  "type": "string",
@@ -6165,7 +6271,7 @@
6165
6271
  },
6166
6272
  "startTime": {
6167
6273
  "type": "string",
6168
- "description": "Timestamp when the job started."
6274
+ "description": "Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00')"
6169
6275
  },
6170
6276
  "success": {
6171
6277
  "type": "boolean",
package/openapi.yaml CHANGED
@@ -1018,6 +1018,23 @@ paths:
1018
1018
  "5XX":
1019
1019
  $ref: "#/components/responses/RcError"
1020
1020
  operationId: coreStats
1021
+ /job/batch:
1022
+ post:
1023
+ summary: "Run batch of commands"
1024
+ description: "Run a batch of rclone rc commands concurrently."
1025
+ tags: []
1026
+ parameters:
1027
+ - $ref: "#/components/parameters/Job_BatchPostConcurrencyParam"
1028
+ - $ref: "#/components/parameters/Job_BatchPostInputsParam"
1029
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1030
+ responses:
1031
+ "200":
1032
+ $ref: "#/components/responses/JobBatchResponse"
1033
+ "4XX":
1034
+ $ref: "#/components/responses/RcError"
1035
+ "5XX":
1036
+ $ref: "#/components/responses/RcError"
1037
+ operationId: jobBatch
1021
1038
  /job/list:
1022
1039
  post:
1023
1040
  summary: "List jobs"
@@ -1803,6 +1820,27 @@ components:
1803
1820
  type: object
1804
1821
  style: form
1805
1822
  explode: true
1823
+ Job_BatchPostConcurrencyParam:
1824
+ name: concurrency
1825
+ in: query
1826
+ description: "Do this many commands concurrently. Defaults to --transfers if not set."
1827
+ schema:
1828
+ type: integer
1829
+ Job_BatchPostInputsParam:
1830
+ name: inputs
1831
+ in: query
1832
+ description: "List of inputs to the commands with an extra _path parameter."
1833
+ schema:
1834
+ type: array
1835
+ items:
1836
+ type: object
1837
+ required:
1838
+ - _path
1839
+ properties:
1840
+ _path:
1841
+ type: string
1842
+ description: "rc/path"
1843
+ additionalProperties: true
1806
1844
  Operations_CleanupPostFsParam:
1807
1845
  name: fs
1808
1846
  in: query
@@ -2308,7 +2346,7 @@ components:
2308
2346
  type: string
2309
2347
  required: true
2310
2348
  Config_UnlockPostConfigPasswordParam:
2311
- name: config_password
2349
+ name: configPassword
2312
2350
  in: query
2313
2351
  description: "Password used to unlock an encrypted config file."
2314
2352
  schema:
@@ -3078,6 +3116,18 @@ components:
3078
3116
  application/json:
3079
3117
  schema:
3080
3118
  $ref: "#/components/schemas/RcError"
3119
+ JobBatchResponse:
3120
+ description: "Results of the batch job execution."
3121
+ content:
3122
+ application/json:
3123
+ schema:
3124
+ type: object
3125
+ properties:
3126
+ results:
3127
+ type: array
3128
+ items:
3129
+ type: object
3130
+ additionalProperties: true
3081
3131
  EmptyResponse:
3082
3132
  description: "Request succeeded with no response body."
3083
3133
  EmptyObjectResponse:
@@ -3503,6 +3553,15 @@ components:
3503
3553
  goVersion:
3504
3554
  type: string
3505
3555
  description: "Go toolchain version used to build rclone."
3556
+ osVersion:
3557
+ type: string
3558
+ description: "OS Version (e.g. ubuntu 24.04 (64 bit))."
3559
+ osKernel:
3560
+ type: string
3561
+ description: "OS Kernel version (e.g. 6.8.0-86-generic (x86_64))."
3562
+ osArch:
3563
+ type: string
3564
+ description: "CPU architecture in use (e.g. arm64 (ARMv8 compatible))."
3506
3565
  linking:
3507
3566
  type: string
3508
3567
  description: "Linking mode for the binary (static or dynamic)."
@@ -3615,9 +3674,21 @@ components:
3615
3674
  items:
3616
3675
  type: number
3617
3676
  description: "Job IDs suitable for use with `job/status` and `job/stop`."
3677
+ runningIds:
3678
+ type: array
3679
+ items:
3680
+ type: integer
3681
+ description: "Array of integer job ids that are running."
3682
+ finishedIds:
3683
+ type: array
3684
+ items:
3685
+ type: integer
3686
+ description: "Array of integer job ids that are finished."
3618
3687
  required:
3619
3688
  - executeId
3620
3689
  - jobids
3690
+ - runningIds
3691
+ - finishedIds
3621
3692
  JobStatusResponse:
3622
3693
  description: "Detailed status for a background job, including timing, success flag, and optional output."
3623
3694
  content:
@@ -3633,7 +3704,7 @@ components:
3633
3704
  description: "Execution time in seconds."
3634
3705
  endTime:
3635
3706
  type: string
3636
- description: "Timestamp when the job finished."
3707
+ description: "Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00')"
3637
3708
  error:
3638
3709
  type: string
3639
3710
  description: "Error message, or empty string on success."
@@ -3642,7 +3713,7 @@ components:
3642
3713
  description: "Job identifier."
3643
3714
  startTime:
3644
3715
  type: string
3645
- description: "Timestamp when the job started."
3716
+ description: "Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00')"
3646
3717
  success:
3647
3718
  type: boolean
3648
3719
  description: "True if the job completed successfully."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rclone-openapi",
3
- "version": "1.0.17",
3
+ "version": "1.0.18",
4
4
  "keywords": [
5
5
  "rclone",
6
6
  "openapi",
package/types.d.ts CHANGED
@@ -1100,6 +1100,26 @@ export interface paths {
1100
1100
  patch?: never;
1101
1101
  trace?: never;
1102
1102
  };
1103
+ "/job/batch": {
1104
+ parameters: {
1105
+ query?: never;
1106
+ header?: never;
1107
+ path?: never;
1108
+ cookie?: never;
1109
+ };
1110
+ get?: never;
1111
+ put?: never;
1112
+ /**
1113
+ * Run batch of commands
1114
+ * @description Run a batch of rclone rc commands concurrently.
1115
+ */
1116
+ post: operations["jobBatch"];
1117
+ delete?: never;
1118
+ options?: never;
1119
+ head?: never;
1120
+ patch?: never;
1121
+ trace?: never;
1122
+ };
1103
1123
  "/job/list": {
1104
1124
  parameters: {
1105
1125
  query?: never;
@@ -2039,6 +2059,19 @@ export interface components {
2039
2059
  "application/json": components["schemas"]["RcError"];
2040
2060
  };
2041
2061
  };
2062
+ /** @description Results of the batch job execution. */
2063
+ JobBatchResponse: {
2064
+ headers: {
2065
+ [name: string]: unknown;
2066
+ };
2067
+ content: {
2068
+ "application/json": {
2069
+ results?: {
2070
+ [key: string]: unknown;
2071
+ }[];
2072
+ };
2073
+ };
2074
+ };
2042
2075
  /** @description Request succeeded with no response body. */
2043
2076
  EmptyResponse: {
2044
2077
  headers: {
@@ -2389,6 +2422,12 @@ export interface components {
2389
2422
  isBeta: boolean;
2390
2423
  /** @description Go toolchain version used to build rclone. */
2391
2424
  goVersion: string;
2425
+ /** @description OS Version (e.g. ubuntu 24.04 (64 bit)). */
2426
+ osVersion?: string;
2427
+ /** @description OS Kernel version (e.g. 6.8.0-86-generic (x86_64)). */
2428
+ osKernel?: string;
2429
+ /** @description CPU architecture in use (e.g. arm64 (ARMv8 compatible)). */
2430
+ osArch?: string;
2392
2431
  /** @description Linking mode for the binary (static or dynamic). */
2393
2432
  linking: string;
2394
2433
  /** @description Space separated Go build tags, if any. */
@@ -2442,6 +2481,10 @@ export interface components {
2442
2481
  executeId: string;
2443
2482
  /** @description Job IDs suitable for use with `job/status` and `job/stop`. */
2444
2483
  jobids: number[];
2484
+ /** @description Array of integer job ids that are running. */
2485
+ runningIds: number[];
2486
+ /** @description Array of integer job ids that are finished. */
2487
+ finishedIds: number[];
2445
2488
  };
2446
2489
  };
2447
2490
  };
@@ -2456,13 +2499,13 @@ export interface components {
2456
2499
  finished: boolean;
2457
2500
  /** @description Execution time in seconds. */
2458
2501
  duration: number;
2459
- /** @description Timestamp when the job finished. */
2502
+ /** @description Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00') */
2460
2503
  endTime: string;
2461
2504
  /** @description Error message, or empty string on success. */
2462
2505
  error: string;
2463
2506
  /** @description Job identifier. */
2464
2507
  id: number;
2465
- /** @description Timestamp when the job started. */
2508
+ /** @description Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00') */
2466
2509
  startTime: string;
2467
2510
  /** @description True if the job completed successfully. */
2468
2511
  success: boolean;
@@ -3048,6 +3091,15 @@ export interface components {
3048
3091
  GlobalGroupParam: string;
3049
3092
  /** @description Additional arbitrary parameters allowed. */
3050
3093
  Rc_NoopPostAdditionalParam: Record<string, never>;
3094
+ /** @description Do this many commands concurrently. Defaults to --transfers if not set. */
3095
+ Job_BatchPostConcurrencyParam: number;
3096
+ /** @description List of inputs to the commands with an extra _path parameter. */
3097
+ Job_BatchPostInputsParam: ({
3098
+ /** @description rc/path */
3099
+ _path: string;
3100
+ } & {
3101
+ [key: string]: unknown;
3102
+ })[];
3051
3103
  /** @description Remote name or path to clean up, for example `drive:`. */
3052
3104
  Operations_CleanupPostFsParam: string;
3053
3105
  /** @description Source remote name or path, such as `drive:` or `/` for the local filesystem. */
@@ -4692,7 +4744,7 @@ export interface operations {
4692
4744
  parameters: {
4693
4745
  query: {
4694
4746
  /** @description Password used to unlock an encrypted config file. */
4695
- config_password: components["parameters"]["Config_UnlockPostConfigPasswordParam"];
4747
+ configPassword: components["parameters"]["Config_UnlockPostConfigPasswordParam"];
4696
4748
  /** @description Assign the request to a custom stats group. */
4697
4749
  _group?: components["parameters"]["GlobalGroupParam"];
4698
4750
  /** @description Run the command asynchronously. Returns a job id immediately. */
@@ -4776,6 +4828,27 @@ export interface operations {
4776
4828
  "5XX": components["responses"]["RcError"];
4777
4829
  };
4778
4830
  };
4831
+ jobBatch: {
4832
+ parameters: {
4833
+ query?: {
4834
+ /** @description Do this many commands concurrently. Defaults to --transfers if not set. */
4835
+ concurrency?: components["parameters"]["Job_BatchPostConcurrencyParam"];
4836
+ /** @description List of inputs to the commands with an extra _path parameter. */
4837
+ inputs?: components["parameters"]["Job_BatchPostInputsParam"];
4838
+ /** @description Run the command asynchronously. Returns a job id immediately. */
4839
+ _async?: components["parameters"]["GlobalAsyncParam"];
4840
+ };
4841
+ header?: never;
4842
+ path?: never;
4843
+ cookie?: never;
4844
+ };
4845
+ requestBody?: never;
4846
+ responses: {
4847
+ 200: components["responses"]["JobBatchResponse"];
4848
+ "4XX": components["responses"]["RcError"];
4849
+ "5XX": components["responses"]["RcError"];
4850
+ };
4851
+ };
4779
4852
  jobList: {
4780
4853
  parameters: {
4781
4854
  query?: {