rclone-openapi 1.0.10 → 1.0.12

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.
Files changed (3) hide show
  1. package/openapi.json +106 -8
  2. package/package.json +3 -2
  3. package/types.d.ts +2367 -2270
package/openapi.json CHANGED
@@ -13,12 +13,19 @@
13
13
  "url": "https://opensource.org/licenses/MIT"
14
14
  }
15
15
  },
16
+ "servers": [
17
+ {
18
+ "url": "http://localhost:5572",
19
+ "description": "Local rclone RC endpoint"
20
+ }
21
+ ],
16
22
  "paths": {
17
23
  "/rc/noop": {
18
24
  "post": {
19
25
  "summary": "Echo request parameters",
20
26
  "description": "Returns all supplied parameters unchanged so you can verify RC connectivity.",
21
27
  "tags": [],
28
+ "operationId": "rcNoop",
22
29
  "parameters": [
23
30
  {
24
31
  "$ref": "#/components/parameters/Rc_NoopPostAdditionalParam"
@@ -45,6 +52,7 @@
45
52
  "summary": "Remove trashed files",
46
53
  "description": "Permanently removes trashed objects from the specified remote path.",
47
54
  "tags": [],
55
+ "operationId": "operationsCleanup",
48
56
  "parameters": [
49
57
  {
50
58
  "$ref": "#/components/parameters/Operations_CleanupPostFsParam"
@@ -74,6 +82,7 @@
74
82
  "summary": "Copy a single file",
75
83
  "description": "Copies one object from a source remote and path to a destination remote and path.",
76
84
  "tags": [],
85
+ "operationId": "operationsCopyfile",
77
86
  "parameters": [
78
87
  {
79
88
  "$ref": "#/components/parameters/Operations_CopyfilePostSrcFsParam"
@@ -112,6 +121,7 @@
112
121
  "summary": "Copy from URL",
113
122
  "description": "Downloads a public URL and stores it at the requested remote path.",
114
123
  "tags": [],
124
+ "operationId": "operationsCopyurl",
115
125
  "parameters": [
116
126
  {
117
127
  "$ref": "#/components/parameters/Operations_CopyurlPostFsParam"
@@ -150,6 +160,7 @@
150
160
  "summary": "Delete objects in path",
151
161
  "description": "Deletes matching files and directories for the provided remote, honouring filters and config overrides.",
152
162
  "tags": [],
163
+ "operationId": "operationsDelete",
153
164
  "parameters": [
154
165
  {
155
166
  "$ref": "#/components/parameters/Operations_DeletePostFsParam"
@@ -185,6 +196,7 @@
185
196
  "summary": "Delete single file",
186
197
  "description": "Removes a specific object from the remote.",
187
198
  "tags": [],
199
+ "operationId": "operationsDeletefile",
188
200
  "parameters": [
189
201
  {
190
202
  "$ref": "#/components/parameters/Operations_DeletefilePostFsParam"
@@ -217,6 +229,7 @@
217
229
  "summary": "Describe remote capabilities",
218
230
  "description": "Returns backend features, hash support, metadata descriptions, and other info for the remote.",
219
231
  "tags": [],
232
+ "operationId": "operationsFsinfo",
220
233
  "parameters": [
221
234
  {
222
235
  "$ref": "#/components/parameters/Operations_FsinfoPostFsParam"
@@ -246,6 +259,7 @@
246
259
  "summary": "Generate hash sums",
247
260
  "description": "Produces a hash sum listing for files under the given path using the requested hash algorithm.",
248
261
  "tags": [],
262
+ "operationId": "operationsHashsum",
249
263
  "parameters": [
250
264
  {
251
265
  "$ref": "#/components/parameters/Operations_HashsumPostFsParam"
@@ -284,6 +298,7 @@
284
298
  "summary": "Move a single file",
285
299
  "description": "Moves one object from a source remote and path to a destination remote and path.",
286
300
  "tags": [],
301
+ "operationId": "operationsMovefile",
287
302
  "parameters": [
288
303
  {
289
304
  "$ref": "#/components/parameters/Operations_MovefilePostSrcFsParam"
@@ -322,6 +337,7 @@
322
337
  "summary": "Create or remove public link",
323
338
  "description": "Creates a share URL for an object or removes an existing link when `unlink=true`.",
324
339
  "tags": [],
340
+ "operationId": "operationsPubliclink",
325
341
  "parameters": [
326
342
  {
327
343
  "$ref": "#/components/parameters/Operations_PubliclinkPostFsParam"
@@ -360,6 +376,7 @@
360
376
  "summary": "Remove empty directories",
361
377
  "description": "Deletes empty subdirectories beneath the specified path, optionally leaving the root.",
362
378
  "tags": [],
379
+ "operationId": "operationsRmdirs",
363
380
  "parameters": [
364
381
  {
365
382
  "$ref": "#/components/parameters/Operations_RmdirsPostFsParam"
@@ -395,6 +412,7 @@
395
412
  "summary": "Change storage tier",
396
413
  "description": "Updates the storage class or tier for every object in the specified remote path.",
397
414
  "tags": [],
415
+ "operationId": "operationsSettier",
398
416
  "parameters": [
399
417
  {
400
418
  "$ref": "#/components/parameters/Operations_SettierPostFsParam"
@@ -424,6 +442,7 @@
424
442
  "summary": "Change file storage tier",
425
443
  "description": "Updates the storage class or tier for a single object.",
426
444
  "tags": [],
445
+ "operationId": "operationsSettierfile",
427
446
  "parameters": [
428
447
  {
429
448
  "$ref": "#/components/parameters/Operations_SettierfilePostFsParam"
@@ -456,6 +475,7 @@
456
475
  "summary": "Count remote size",
457
476
  "description": "Reports total size, file count, and number of objects without size metadata.",
458
477
  "tags": [],
478
+ "operationId": "operationsSize",
459
479
  "parameters": [
460
480
  {
461
481
  "$ref": "#/components/parameters/Operations_SizePostFsParam"
@@ -485,6 +505,7 @@
485
505
  "summary": "Get or update bandwidth limits",
486
506
  "description": "Reads the current bandwidth limit or applies a new schedule string, just like `rclone rc core/bwlimit`.",
487
507
  "tags": [],
508
+ "operationId": "coreBwlimit",
488
509
  "parameters": [
489
510
  {
490
511
  "$ref": "#/components/parameters/Core_BwlimitPostRateParam"
@@ -514,6 +535,7 @@
514
535
  "summary": "Run an rclone command",
515
536
  "description": "Executes a standard rclone CLI command remotely and streams or returns its output.",
516
537
  "tags": [],
538
+ "operationId": "coreCommand",
517
539
  "parameters": [
518
540
  {
519
541
  "$ref": "#/components/parameters/Core_CommandPostCommandParam"
@@ -552,6 +574,7 @@
552
574
  "summary": "Report disk usage",
553
575
  "description": "Returns disk usage statistics for the supplied local directory (defaults to the cache dir).",
554
576
  "tags": [],
577
+ "operationId": "coreDu",
555
578
  "parameters": [
556
579
  {
557
580
  "$ref": "#/components/parameters/Core_DuPostDirParam"
@@ -581,6 +604,7 @@
581
604
  "summary": "Force garbage collection",
582
605
  "description": "Triggers Go's garbage collector to release unused memory.",
583
606
  "tags": [],
607
+ "operationId": "coreGc",
584
608
  "parameters": [
585
609
  {
586
610
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -607,6 +631,7 @@
607
631
  "summary": "List stats groups",
608
632
  "description": "Lists stats groups currently tracked by rclone.",
609
633
  "tags": [],
634
+ "operationId": "coreGroupList",
610
635
  "parameters": [
611
636
  {
612
637
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -651,6 +676,7 @@
651
676
  "summary": "Fetch runtime memory stats",
652
677
  "description": "Returns Go runtime memory statistics similar to `runtime.ReadMemStats`.",
653
678
  "tags": [],
679
+ "operationId": "coreMemstats",
654
680
  "parameters": [
655
681
  {
656
682
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -687,6 +713,7 @@
687
713
  "summary": "Obscure a clear string",
688
714
  "description": "Obscures a plain-text secret for inclusion in `rclone.conf`.",
689
715
  "tags": [],
716
+ "operationId": "coreObscure",
690
717
  "parameters": [
691
718
  {
692
719
  "$ref": "#/components/parameters/Core_ObscurePostClearParam"
@@ -731,6 +758,7 @@
731
758
  "summary": "Return rclone PID",
732
759
  "description": "Returns the process ID of the running rclone instance.",
733
760
  "tags": [],
761
+ "operationId": "corePid",
734
762
  "parameters": [
735
763
  {
736
764
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -772,6 +800,7 @@
772
800
  "summary": "Terminate rclone",
773
801
  "description": "Stops the rclone process, optionally supplying an exit code.",
774
802
  "tags": [],
803
+ "operationId": "coreQuit",
775
804
  "parameters": [
776
805
  {
777
806
  "$ref": "#/components/parameters/Core_QuitPostExitCodeParam"
@@ -801,6 +830,7 @@
801
830
  "summary": "Delete stats group",
802
831
  "description": "Deletes the counters associated with a specific stats group.",
803
832
  "tags": [],
833
+ "operationId": "coreStatsDelete",
804
834
  "parameters": [
805
835
  {
806
836
  "$ref": "#/components/parameters/Core_StatsDeletePostGroupParam"
@@ -830,6 +860,7 @@
830
860
  "summary": "Reset stats counters",
831
861
  "description": "Clears counters, errors, and finished transfers for the provided stats group or all groups.",
832
862
  "tags": [],
863
+ "operationId": "coreStatsReset",
833
864
  "parameters": [
834
865
  {
835
866
  "$ref": "#/components/parameters/Core_StatsResetPostGroupParam"
@@ -859,6 +890,7 @@
859
890
  "summary": "List completed transfers",
860
891
  "description": "Returns up to 100 recently completed transfers for the requested stats group.",
861
892
  "tags": [],
893
+ "operationId": "coreTransferred",
862
894
  "parameters": [
863
895
  {
864
896
  "$ref": "#/components/parameters/Core_TransferredPostGroupParam"
@@ -886,6 +918,7 @@
886
918
  "/debug/set-block-profile-rate": {
887
919
  "post": {
888
920
  "tags": [],
921
+ "operationId": "debugSetBlockProfileRate",
889
922
  "parameters": [
890
923
  {
891
924
  "$ref": "#/components/parameters/Debug_SetBlockProfileRatePostRateParam"
@@ -913,6 +946,7 @@
913
946
  "/debug/set-gc-percent": {
914
947
  "post": {
915
948
  "tags": [],
949
+ "operationId": "debugSetGcPercent",
916
950
  "parameters": [
917
951
  {
918
952
  "$ref": "#/components/parameters/Debug_SetGcPercentPostGcPercentParam"
@@ -940,6 +974,7 @@
940
974
  "/debug/set-mutex-profile-fraction": {
941
975
  "post": {
942
976
  "tags": [],
977
+ "operationId": "debugSetMutexProfileFraction",
943
978
  "parameters": [
944
979
  {
945
980
  "$ref": "#/components/parameters/Debug_SetMutexProfileFractionPostRateParam"
@@ -967,6 +1002,7 @@
967
1002
  "/debug/set-soft-memory-limit": {
968
1003
  "post": {
969
1004
  "tags": [],
1005
+ "operationId": "debugSetSoftMemoryLimit",
970
1006
  "parameters": [
971
1007
  {
972
1008
  "$ref": "#/components/parameters/Debug_SetSoftMemoryLimitPostMemLimitParam"
@@ -994,6 +1030,7 @@
994
1030
  "/fscache/clear": {
995
1031
  "post": {
996
1032
  "tags": [],
1033
+ "operationId": "fscacheClear",
997
1034
  "parameters": [
998
1035
  {
999
1036
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1018,6 +1055,7 @@
1018
1055
  "/fscache/entries": {
1019
1056
  "post": {
1020
1057
  "tags": [],
1058
+ "operationId": "fscacheEntries",
1021
1059
  "parameters": [
1022
1060
  {
1023
1061
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1042,6 +1080,7 @@
1042
1080
  "/mount/listmounts": {
1043
1081
  "post": {
1044
1082
  "tags": [],
1083
+ "operationId": "mountListmounts",
1045
1084
  "parameters": [
1046
1085
  {
1047
1086
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1066,6 +1105,7 @@
1066
1105
  "/mount/mount": {
1067
1106
  "post": {
1068
1107
  "tags": [],
1108
+ "operationId": "mountMount",
1069
1109
  "parameters": [
1070
1110
  {
1071
1111
  "$ref": "#/components/parameters/Mount_MountPostFsParam"
@@ -1111,6 +1151,7 @@
1111
1151
  "/mount/types": {
1112
1152
  "post": {
1113
1153
  "tags": [],
1154
+ "operationId": "mountTypes",
1114
1155
  "parameters": [
1115
1156
  {
1116
1157
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1135,6 +1176,7 @@
1135
1176
  "/mount/unmount": {
1136
1177
  "post": {
1137
1178
  "tags": [],
1179
+ "operationId": "mountUnmount",
1138
1180
  "parameters": [
1139
1181
  {
1140
1182
  "$ref": "#/components/parameters/Mount_UnmountPostMountPointParam"
@@ -1162,6 +1204,7 @@
1162
1204
  "/mount/unmountall": {
1163
1205
  "post": {
1164
1206
  "tags": [],
1207
+ "operationId": "mountUnmountall",
1165
1208
  "parameters": [
1166
1209
  {
1167
1210
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1188,6 +1231,7 @@
1188
1231
  "summary": "Echo parameters (auth required)",
1189
1232
  "description": "Same as `rc/noop`, but requires authentication to validate access control.",
1190
1233
  "tags": [],
1234
+ "operationId": "rcNoopAuth",
1191
1235
  "parameters": [
1192
1236
  {
1193
1237
  "$ref": "#/components/parameters/Rc_NoopauthPostAdditionalParam"
@@ -1214,6 +1258,7 @@
1214
1258
  "summary": "Return a test error",
1215
1259
  "description": "Always returns an error response incorporating the supplied parameters, useful for testing error handling.",
1216
1260
  "tags": [],
1261
+ "operationId": "rcError",
1217
1262
  "parameters": [
1218
1263
  {
1219
1264
  "$ref": "#/components/parameters/Rc_ErrorPostAdditionalParam"
@@ -1240,6 +1285,7 @@
1240
1285
  "summary": "List RC commands",
1241
1286
  "description": "Returns metadata about every available RC command, including whether authentication is required.",
1242
1287
  "tags": [],
1288
+ "operationId": "rcList",
1243
1289
  "parameters": [
1244
1290
  {
1245
1291
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1266,6 +1312,7 @@
1266
1312
  "summary": "Run backend command",
1267
1313
  "description": "Invokes a backend-specific management command against an optional remote.",
1268
1314
  "tags": [],
1315
+ "operationId": "backendCommand",
1269
1316
  "parameters": [
1270
1317
  {
1271
1318
  "$ref": "#/components/parameters/Backend_CommandPostCommandParam"
@@ -1304,6 +1351,7 @@
1304
1351
  "summary": "Expire cache entries",
1305
1352
  "description": "Drops cached directory entries, and optionally cached file data, for the cache backend.",
1306
1353
  "tags": [],
1354
+ "operationId": "cacheExpire",
1307
1355
  "parameters": [
1308
1356
  {
1309
1357
  "$ref": "#/components/parameters/Cache_ExpirePostRemoteParam"
@@ -1336,6 +1384,7 @@
1336
1384
  "summary": "Prefetch cache chunks",
1337
1385
  "description": "Ensures specified file chunks are cached locally for a cache remote.",
1338
1386
  "tags": [],
1387
+ "operationId": "cacheFetch",
1339
1388
  "parameters": [
1340
1389
  {
1341
1390
  "$ref": "#/components/parameters/Cache_FetchPostChunksParam"
@@ -1368,6 +1417,7 @@
1368
1417
  "summary": "Show cache stats",
1369
1418
  "description": "Returns runtime statistics for the cache backend.",
1370
1419
  "tags": [],
1420
+ "operationId": "cacheStats",
1371
1421
  "parameters": [
1372
1422
  {
1373
1423
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1394,6 +1444,7 @@
1394
1444
  "summary": "Create remote configuration",
1395
1445
  "description": "Creates a new remote in `rclone.conf`, mirroring `rclone config create`.",
1396
1446
  "tags": [],
1447
+ "operationId": "configCreate",
1397
1448
  "parameters": [
1398
1449
  {
1399
1450
  "$ref": "#/components/parameters/Config_CreatePostNameParam"
@@ -1432,6 +1483,7 @@
1432
1483
  "summary": "Delete remote configuration",
1433
1484
  "description": "Removes an existing remote from `rclone.conf`.",
1434
1485
  "tags": [],
1486
+ "operationId": "configDelete",
1435
1487
  "parameters": [
1436
1488
  {
1437
1489
  "$ref": "#/components/parameters/Config_DeletePostNameParam"
@@ -1461,6 +1513,7 @@
1461
1513
  "summary": "Dump configuration",
1462
1514
  "description": "Returns the contents of the config file as a JSON object keyed by remote name.",
1463
1515
  "tags": [],
1516
+ "operationId": "configDump",
1464
1517
  "parameters": [
1465
1518
  {
1466
1519
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1487,6 +1540,7 @@
1487
1540
  "summary": "Get remote configuration",
1488
1541
  "description": "Returns the key/value settings for a single remote.",
1489
1542
  "tags": [],
1543
+ "operationId": "configGet",
1490
1544
  "parameters": [
1491
1545
  {
1492
1546
  "$ref": "#/components/parameters/Config_GetPostNameParam"
@@ -1516,6 +1570,7 @@
1516
1570
  "summary": "List configured remotes",
1517
1571
  "description": "Returns the names of all remotes defined in the config file.",
1518
1572
  "tags": [],
1573
+ "operationId": "configListremotes",
1519
1574
  "parameters": [
1520
1575
  {
1521
1576
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1542,6 +1597,7 @@
1542
1597
  "summary": "Update remote secrets",
1543
1598
  "description": "Sets obscured password fields for a remote configuration.",
1544
1599
  "tags": [],
1600
+ "operationId": "configPassword",
1545
1601
  "parameters": [
1546
1602
  {
1547
1603
  "$ref": "#/components/parameters/Config_PasswordPostNameParam"
@@ -1574,6 +1630,7 @@
1574
1630
  "summary": "Show config paths",
1575
1631
  "description": "Returns the paths to the config file, cache directory, and temporary directory.",
1576
1632
  "tags": [],
1633
+ "operationId": "configPaths",
1577
1634
  "parameters": [
1578
1635
  {
1579
1636
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1600,6 +1657,7 @@
1600
1657
  "summary": "List backend providers",
1601
1658
  "description": "Returns metadata describing each supported storage provider.",
1602
1659
  "tags": [],
1660
+ "operationId": "configProviders",
1603
1661
  "parameters": [
1604
1662
  {
1605
1663
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1626,6 +1684,7 @@
1626
1684
  "summary": "Set config path",
1627
1685
  "description": "Points rclone at a specific `rclone.conf` file.",
1628
1686
  "tags": [],
1687
+ "operationId": "configSetpath",
1629
1688
  "parameters": [
1630
1689
  {
1631
1690
  "$ref": "#/components/parameters/Config_SetpathPostPathParam"
@@ -1655,6 +1714,7 @@
1655
1714
  "summary": "Unlock encrypted config",
1656
1715
  "description": "Unlocks the configuration file using the provided password.",
1657
1716
  "tags": [],
1717
+ "operationId": "configUnlock",
1658
1718
  "parameters": [
1659
1719
  {
1660
1720
  "$ref": "#/components/parameters/Config_UnlockPostConfigPasswordParam"
@@ -1684,6 +1744,7 @@
1684
1744
  "summary": "Update remote configuration",
1685
1745
  "description": "Updates an existing remote with new parameter values.",
1686
1746
  "tags": [],
1747
+ "operationId": "configUpdate",
1687
1748
  "parameters": [
1688
1749
  {
1689
1750
  "$ref": "#/components/parameters/Config_UpdatePostNameParam"
@@ -1719,6 +1780,7 @@
1719
1780
  "summary": "Report rclone version",
1720
1781
  "description": "Returns the running rclone version, build metadata, and Go runtime details.",
1721
1782
  "tags": [],
1783
+ "operationId": "coreVersion",
1722
1784
  "parameters": [
1723
1785
  {
1724
1786
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -1745,6 +1807,7 @@
1745
1807
  "summary": "Current stats snapshot",
1746
1808
  "description": "Returns active transfer statistics including bytes transferred, speed, and error counts.",
1747
1809
  "tags": [],
1810
+ "operationId": "coreStats",
1748
1811
  "parameters": [
1749
1812
  {
1750
1813
  "$ref": "#/components/parameters/Core_StatsPostGroupParam"
@@ -1777,6 +1840,7 @@
1777
1840
  "summary": "List jobs",
1778
1841
  "description": "Returns identifiers of active and recently completed asynchronous jobs.",
1779
1842
  "tags": [],
1843
+ "operationId": "jobList",
1780
1844
  "parameters": [
1781
1845
  {
1782
1846
  "$ref": "#/components/parameters/GlobalAsyncParam"
@@ -1800,6 +1864,7 @@
1800
1864
  "summary": "Get job status",
1801
1865
  "description": "Returns timing, success state, output, and progress for a specific job.",
1802
1866
  "tags": [],
1867
+ "operationId": "jobStatus",
1803
1868
  "parameters": [
1804
1869
  {
1805
1870
  "$ref": "#/components/parameters/Job_StatusPostJobidParam"
@@ -1826,6 +1891,7 @@
1826
1891
  "summary": "Stop job",
1827
1892
  "description": "Attempts to cancel a running job by ID.",
1828
1893
  "tags": [],
1894
+ "operationId": "jobStop",
1829
1895
  "parameters": [
1830
1896
  {
1831
1897
  "$ref": "#/components/parameters/Job_StopPostJobidParam"
@@ -1852,6 +1918,7 @@
1852
1918
  "summary": "Stop jobs in group",
1853
1919
  "description": "Cancels all active jobs associated with the provided stats group.",
1854
1920
  "tags": [],
1921
+ "operationId": "jobStopgroup",
1855
1922
  "parameters": [
1856
1923
  {
1857
1924
  "$ref": "#/components/parameters/Job_StopgroupPostGroupParam"
@@ -1878,6 +1945,7 @@
1878
1945
  "summary": "List objects",
1879
1946
  "description": "Lists objects and directories for a remote path, returning the same fields as `rclone lsjson`.",
1880
1947
  "tags": [],
1948
+ "operationId": "operationsList",
1881
1949
  "parameters": [
1882
1950
  {
1883
1951
  "$ref": "#/components/parameters/Operations_ListPostFsParam"
@@ -1943,6 +2011,7 @@
1943
2011
  "summary": "Stat an object",
1944
2012
  "description": "Returns metadata for a single file or directory, mirroring `rclone lsjson` on one entry.",
1945
2013
  "tags": [],
2014
+ "operationId": "operationsStat",
1946
2015
  "parameters": [
1947
2016
  {
1948
2017
  "$ref": "#/components/parameters/Operations_StatPostFsParam"
@@ -1978,6 +2047,7 @@
1978
2047
  "summary": "Get remote quota",
1979
2048
  "description": "Returns storage quota and usage details for the remote, equivalent to `rclone about`.",
1980
2049
  "tags": [],
2050
+ "operationId": "operationsAbout",
1981
2051
  "parameters": [
1982
2052
  {
1983
2053
  "$ref": "#/components/parameters/Operations_AboutPostFsParam"
@@ -2007,6 +2077,7 @@
2007
2077
  "summary": "Upload files via multipart",
2008
2078
  "description": "Accepts multipart/form-data payloads and writes the uploaded files to the specified remote path.",
2009
2079
  "tags": [],
2080
+ "operationId": "operationsUploadfile",
2010
2081
  "parameters": [
2011
2082
  {
2012
2083
  "$ref": "#/components/parameters/Operations_UploadfilePostFsParam"
@@ -2049,6 +2120,7 @@
2049
2120
  "summary": "Purge directory",
2050
2121
  "description": "Deletes a directory or container and all of its contents.",
2051
2122
  "tags": [],
2123
+ "operationId": "operationsPurge",
2052
2124
  "parameters": [
2053
2125
  {
2054
2126
  "$ref": "#/components/parameters/Operations_PurgePostFsParam"
@@ -2087,6 +2159,7 @@
2087
2159
  "summary": "Create directory",
2088
2160
  "description": "Creates the target directory or container if it does not exist.",
2089
2161
  "tags": [],
2162
+ "operationId": "operationsMkdir",
2090
2163
  "parameters": [
2091
2164
  {
2092
2165
  "$ref": "#/components/parameters/Operations_MkdirPostFsParam"
@@ -2119,6 +2192,7 @@
2119
2192
  "summary": "Remove empty directory",
2120
2193
  "description": "Deletes an empty directory or container.",
2121
2194
  "tags": [],
2195
+ "operationId": "operationsRmdir",
2122
2196
  "parameters": [
2123
2197
  {
2124
2198
  "$ref": "#/components/parameters/Operations_RmdirPostFsParam"
@@ -2151,6 +2225,7 @@
2151
2225
  "summary": "Compare source and destination",
2152
2226
  "description": "Compares source and destination trees, reporting matches, differences, and missing files.",
2153
2227
  "tags": [],
2228
+ "operationId": "operationsCheck",
2154
2229
  "parameters": [
2155
2230
  {
2156
2231
  "$ref": "#/components/parameters/Operations_CheckPostSrcFsParam"
@@ -2216,6 +2291,7 @@
2216
2291
  "summary": "Sync source to destination",
2217
2292
  "description": "Synchronises a source remote to a destination remote, making the destination match the source.",
2218
2293
  "tags": [],
2294
+ "operationId": "syncSync",
2219
2295
  "parameters": [
2220
2296
  {
2221
2297
  "$ref": "#/components/parameters/Sync_SyncPostSrcFsParam"
@@ -2257,6 +2333,7 @@
2257
2333
  "summary": "Copy source to destination",
2258
2334
  "description": "Copies objects from a source remote to a destination remote without deleting destination files.",
2259
2335
  "tags": [],
2336
+ "operationId": "syncCopy",
2260
2337
  "parameters": [
2261
2338
  {
2262
2339
  "$ref": "#/components/parameters/Sync_CopyPostSrcFsParam"
@@ -2298,6 +2375,7 @@
2298
2375
  "summary": "Move source to destination",
2299
2376
  "description": "Moves objects from a source remote to a destination remote, optionally cleaning up empty directories.",
2300
2377
  "tags": [],
2378
+ "operationId": "syncMove",
2301
2379
  "parameters": [
2302
2380
  {
2303
2381
  "$ref": "#/components/parameters/Sync_MovePostSrcFsParam"
@@ -2342,6 +2420,7 @@
2342
2420
  "summary": "Bidirectional sync",
2343
2421
  "description": "Performs a bidirectional synchronisation between two paths, supporting safety checks and recovery options.",
2344
2422
  "tags": [],
2423
+ "operationId": "syncBisync",
2345
2424
  "parameters": [
2346
2425
  {
2347
2426
  "$ref": "#/components/parameters/Sync_BisyncPostPath1Param"
@@ -2428,6 +2507,7 @@
2428
2507
  "summary": "List option blocks",
2429
2508
  "description": "Returns the names of option blocks that can be queried or updated.",
2430
2509
  "tags": [],
2510
+ "operationId": "optionsBlocks",
2431
2511
  "parameters": [
2432
2512
  {
2433
2513
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -2454,6 +2534,7 @@
2454
2534
  "summary": "Get option values",
2455
2535
  "description": "Returns the current global option values, optionally filtered by block.",
2456
2536
  "tags": [],
2537
+ "operationId": "optionsGet",
2457
2538
  "parameters": [
2458
2539
  {
2459
2540
  "$ref": "#/components/parameters/Options_GetPostBlocksParam"
@@ -2483,6 +2564,7 @@
2483
2564
  "summary": "Describe options",
2484
2565
  "description": "Returns metadata for options, including help text and defaults, grouped by block.",
2485
2566
  "tags": [],
2567
+ "operationId": "optionsInfo",
2486
2568
  "parameters": [
2487
2569
  {
2488
2570
  "$ref": "#/components/parameters/Options_InfoPostBlocksParam"
@@ -2512,6 +2594,7 @@
2512
2594
  "summary": "Set option values",
2513
2595
  "description": "Sets temporary option overrides for the running process by supplying key/value pairs grouped under option block names. Provide one or more query parameters whose names match the blocks you want to modify (for example `main`, `rc`, `http`). Each block parameter carries an object of option overrides.\n",
2514
2596
  "tags": [],
2597
+ "operationId": "optionsSet",
2515
2598
  "x-additionalQueryBlocksAllowed": true,
2516
2599
  "parameters": [
2517
2600
  {
@@ -2584,6 +2667,7 @@
2584
2667
  "summary": "Show effective options",
2585
2668
  "description": "Returns the current effective options for this request, including `_config` and `_filter` overrides.",
2586
2669
  "tags": [],
2670
+ "operationId": "optionsLocal",
2587
2671
  "parameters": [
2588
2672
  {
2589
2673
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -2610,6 +2694,7 @@
2610
2694
  "summary": "List serve instances",
2611
2695
  "description": "Returns all running `rclone serve` instances with their IDs and options.",
2612
2696
  "tags": [],
2697
+ "operationId": "serveList",
2613
2698
  "parameters": [
2614
2699
  {
2615
2700
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -2636,6 +2721,7 @@
2636
2721
  "summary": "Start serve instance",
2637
2722
  "description": "Launches a new `rclone serve` endpoint (http, webdav, ftp, etc.) with the provided parameters.",
2638
2723
  "tags": [],
2724
+ "operationId": "serveStart",
2639
2725
  "parameters": [
2640
2726
  {
2641
2727
  "$ref": "#/components/parameters/Serve_StartPostTypeParam"
@@ -2680,6 +2766,7 @@
2680
2766
  "summary": "Stop serve instance",
2681
2767
  "description": "Stops a running `serve` instance identified by its ID.",
2682
2768
  "tags": [],
2769
+ "operationId": "serveStop",
2683
2770
  "parameters": [
2684
2771
  {
2685
2772
  "$ref": "#/components/parameters/Serve_StopPostIdParam"
@@ -2709,6 +2796,7 @@
2709
2796
  "summary": "Stop all serve instances",
2710
2797
  "description": "Stops every active `serve` instance.",
2711
2798
  "tags": [],
2799
+ "operationId": "serveStopall",
2712
2800
  "parameters": [
2713
2801
  {
2714
2802
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -2735,6 +2823,7 @@
2735
2823
  "summary": "List serve types",
2736
2824
  "description": "Returns the list of supported `rclone serve` protocols.",
2737
2825
  "tags": [],
2826
+ "operationId": "serveTypes",
2738
2827
  "parameters": [
2739
2828
  {
2740
2829
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -2761,6 +2850,7 @@
2761
2850
  "summary": "Forget cached paths",
2762
2851
  "description": "Evicts specific files or directories from the VFS directory cache.",
2763
2852
  "tags": [],
2853
+ "operationId": "vfsForget",
2764
2854
  "parameters": [
2765
2855
  {
2766
2856
  "$ref": "#/components/parameters/Vfs_ForgetPostFsParam"
@@ -2793,6 +2883,7 @@
2793
2883
  "summary": "List VFS instances",
2794
2884
  "description": "Lists the active VFS instances and their identifiers.",
2795
2885
  "tags": [],
2886
+ "operationId": "vfsList",
2796
2887
  "parameters": [
2797
2888
  {
2798
2889
  "$ref": "#/components/parameters/Vfs_ListPostFsParam"
@@ -2822,6 +2913,7 @@
2822
2913
  "summary": "Get or set poll interval",
2823
2914
  "description": "Reads or updates the VFS poll interval duration, optionally waiting for the change to apply.",
2824
2915
  "tags": [],
2916
+ "operationId": "vfsPollInterval",
2825
2917
  "parameters": [
2826
2918
  {
2827
2919
  "$ref": "#/components/parameters/Vfs_PollIntervalPostFsParam"
@@ -2857,6 +2949,7 @@
2857
2949
  "summary": "Inspect upload queue",
2858
2950
  "description": "Returns the contents of the VFS upload queue.",
2859
2951
  "tags": [],
2952
+ "operationId": "vfsQueue",
2860
2953
  "parameters": [
2861
2954
  {
2862
2955
  "$ref": "#/components/parameters/Vfs_QueuePostFsParam"
@@ -2886,6 +2979,7 @@
2886
2979
  "summary": "Adjust queue expiry",
2887
2980
  "description": "Sets the expiry time of a queued VFS upload item, optionally relative to its current value.",
2888
2981
  "tags": [],
2982
+ "operationId": "vfsQueueSetExpiry",
2889
2983
  "parameters": [
2890
2984
  {
2891
2985
  "$ref": "#/components/parameters/Vfs_QueueSetExpiryPostFsParam"
@@ -2924,6 +3018,7 @@
2924
3018
  "summary": "Refresh directory cache",
2925
3019
  "description": "Refreshes one or more directories in the VFS cache, optionally recursively.",
2926
3020
  "tags": [],
3021
+ "operationId": "vfsRefresh",
2927
3022
  "parameters": [
2928
3023
  {
2929
3024
  "$ref": "#/components/parameters/Vfs_RefreshPostFsParam"
@@ -2959,6 +3054,7 @@
2959
3054
  "summary": "Show VFS stats",
2960
3055
  "description": "Returns VFS statistics including disk cache usage and metadata cache counters.",
2961
3056
  "tags": [],
3057
+ "operationId": "vfsStats",
2962
3058
  "parameters": [
2963
3059
  {
2964
3060
  "$ref": "#/components/parameters/Vfs_StatsPostFsParam"
@@ -2988,6 +3084,7 @@
2988
3084
  "summary": "Install plugin",
2989
3085
  "description": "Downloads and installs a plugin into the WebUI from the provided repository URL.",
2990
3086
  "tags": [],
3087
+ "operationId": "pluginsctlAddPlugin",
2991
3088
  "parameters": [
2992
3089
  {
2993
3090
  "$ref": "#/components/parameters/Pluginsctl_AddPluginPostUrlParam"
@@ -3017,6 +3114,7 @@
3017
3114
  "summary": "Filter plugins by MIME type",
3018
3115
  "description": "Returns plugins matching the requested MIME type and optional plugin type.",
3019
3116
  "tags": [],
3117
+ "operationId": "pluginsctlGetPluginsForType",
3020
3118
  "parameters": [
3021
3119
  {
3022
3120
  "$ref": "#/components/parameters/Pluginsctl_GetPluginsForTypePostTypeParam"
@@ -3049,6 +3147,7 @@
3049
3147
  "summary": "List installed plugins",
3050
3148
  "description": "Returns metadata for installed production and test plugins.",
3051
3149
  "tags": [],
3150
+ "operationId": "pluginsctlListPlugins",
3052
3151
  "parameters": [
3053
3152
  {
3054
3153
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -3075,6 +3174,7 @@
3075
3174
  "summary": "List installed test plugins",
3076
3175
  "description": "Returns metadata for installed test plugins.",
3077
3176
  "tags": [],
3177
+ "operationId": "pluginsctlListTestPlugins",
3078
3178
  "parameters": [
3079
3179
  {
3080
3180
  "$ref": "#/components/parameters/GlobalGroupParam"
@@ -3101,6 +3201,7 @@
3101
3201
  "summary": "Remove plugin",
3102
3202
  "description": "Uninstalls a plugin from the WebUI.",
3103
3203
  "tags": [],
3204
+ "operationId": "pluginsctlRemovePlugin",
3104
3205
  "parameters": [
3105
3206
  {
3106
3207
  "$ref": "#/components/parameters/Pluginsctl_RemovePluginPostNameParam"
@@ -3130,6 +3231,7 @@
3130
3231
  "summary": "Remove test plugin",
3131
3232
  "description": "Uninstalls a test plugin from the WebUI.",
3132
3233
  "tags": [],
3234
+ "operationId": "pluginsctlRemoveTestPlugin",
3133
3235
  "parameters": [
3134
3236
  {
3135
3237
  "$ref": "#/components/parameters/Pluginsctl_RemoveTestPluginPostNameParam"
@@ -7587,12 +7689,10 @@
7587
7689
  "type": "boolean"
7588
7690
  },
7589
7691
  "MetadataInfo": {
7590
- "anyOf": [
7692
+ "nullable": true,
7693
+ "allOf": [
7591
7694
  {
7592
7695
  "$ref": "#/components/schemas/ConfigProviderMetadataInfo"
7593
- },
7594
- {
7595
- "type": "null"
7596
7696
  }
7597
7697
  ]
7598
7698
  },
@@ -7926,11 +8026,9 @@
7926
8026
  {
7927
8027
  "type": "object",
7928
8028
  "additionalProperties": true
7929
- },
7930
- {
7931
- "type": "null"
7932
8029
  }
7933
- ]
8030
+ ],
8031
+ "nullable": true
7934
8032
  },
7935
8033
  "ConfigProviderOptionType": {
7936
8034
  "type": "string",