rclone-openapi 1.72.1 → 1.73.0
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 +110 -1
- package/openapi.yaml +71 -1
- package/package.json +3 -3
- package/types.d.ts +73 -0
package/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Rclone RC API",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.73.0",
|
|
6
6
|
"description": "Full OpenAPI specification for the Rclone RC API.",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "GitHub Repository",
|
|
@@ -293,6 +293,48 @@
|
|
|
293
293
|
"operationId": "operationsHashsum"
|
|
294
294
|
}
|
|
295
295
|
},
|
|
296
|
+
"/operations/hashsumfile": {
|
|
297
|
+
"post": {
|
|
298
|
+
"summary": "Hash a single file",
|
|
299
|
+
"description": "Returns the hash of a single file using the specified hash algorithm.",
|
|
300
|
+
"tags": [],
|
|
301
|
+
"parameters": [
|
|
302
|
+
{
|
|
303
|
+
"$ref": "#/components/parameters/Operations_HashsumfilePostFsParam"
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
"$ref": "#/components/parameters/Operations_HashsumfilePostRemoteParam"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"$ref": "#/components/parameters/Operations_HashsumfilePostHashTypeParam"
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"$ref": "#/components/parameters/Operations_HashsumfilePostDownloadParam"
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"$ref": "#/components/parameters/Operations_HashsumfilePostBase64Param"
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
"$ref": "#/components/parameters/GlobalGroupParam"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"$ref": "#/components/parameters/GlobalAsyncParam"
|
|
322
|
+
}
|
|
323
|
+
],
|
|
324
|
+
"responses": {
|
|
325
|
+
"200": {
|
|
326
|
+
"$ref": "#/components/responses/OperationsHashsumfileResponse"
|
|
327
|
+
},
|
|
328
|
+
"4XX": {
|
|
329
|
+
"$ref": "#/components/responses/RcError"
|
|
330
|
+
},
|
|
331
|
+
"5XX": {
|
|
332
|
+
"$ref": "#/components/responses/RcError"
|
|
333
|
+
}
|
|
334
|
+
},
|
|
335
|
+
"operationId": "operationsHashsumfile"
|
|
336
|
+
}
|
|
337
|
+
},
|
|
296
338
|
"/operations/movefile": {
|
|
297
339
|
"post": {
|
|
298
340
|
"summary": "Move a single file",
|
|
@@ -3519,6 +3561,49 @@
|
|
|
3519
3561
|
"type": "boolean"
|
|
3520
3562
|
}
|
|
3521
3563
|
},
|
|
3564
|
+
"Operations_HashsumfilePostFsParam": {
|
|
3565
|
+
"name": "fs",
|
|
3566
|
+
"in": "query",
|
|
3567
|
+
"description": "Remote name or path containing the file to hash.",
|
|
3568
|
+
"schema": {
|
|
3569
|
+
"type": "string"
|
|
3570
|
+
},
|
|
3571
|
+
"required": true
|
|
3572
|
+
},
|
|
3573
|
+
"Operations_HashsumfilePostRemoteParam": {
|
|
3574
|
+
"name": "remote",
|
|
3575
|
+
"in": "query",
|
|
3576
|
+
"description": "Path to the specific file within `fs` to hash.",
|
|
3577
|
+
"schema": {
|
|
3578
|
+
"type": "string"
|
|
3579
|
+
},
|
|
3580
|
+
"required": true
|
|
3581
|
+
},
|
|
3582
|
+
"Operations_HashsumfilePostHashTypeParam": {
|
|
3583
|
+
"name": "hashType",
|
|
3584
|
+
"in": "query",
|
|
3585
|
+
"description": "Hash algorithm to use, e.g. `md5`, `sha1`, or another supported name.",
|
|
3586
|
+
"schema": {
|
|
3587
|
+
"type": "string"
|
|
3588
|
+
},
|
|
3589
|
+
"required": true
|
|
3590
|
+
},
|
|
3591
|
+
"Operations_HashsumfilePostDownloadParam": {
|
|
3592
|
+
"name": "download",
|
|
3593
|
+
"in": "query",
|
|
3594
|
+
"description": "Set to true to force reading the data instead of using remote checksums.",
|
|
3595
|
+
"schema": {
|
|
3596
|
+
"type": "boolean"
|
|
3597
|
+
}
|
|
3598
|
+
},
|
|
3599
|
+
"Operations_HashsumfilePostBase64Param": {
|
|
3600
|
+
"name": "base64",
|
|
3601
|
+
"in": "query",
|
|
3602
|
+
"description": "Set to true to emit the hash value in base64 rather than hexadecimal.",
|
|
3603
|
+
"schema": {
|
|
3604
|
+
"type": "boolean"
|
|
3605
|
+
}
|
|
3606
|
+
},
|
|
3522
3607
|
"Operations_MovefilePostSrcFsParam": {
|
|
3523
3608
|
"name": "srcFs",
|
|
3524
3609
|
"in": "query",
|
|
@@ -5535,6 +5620,30 @@
|
|
|
5535
5620
|
}
|
|
5536
5621
|
}
|
|
5537
5622
|
},
|
|
5623
|
+
"OperationsHashsumfileResponse": {
|
|
5624
|
+
"description": "Hash algorithm used and the hash value for a single file from `operations/hashsumfile`.",
|
|
5625
|
+
"content": {
|
|
5626
|
+
"application/json": {
|
|
5627
|
+
"schema": {
|
|
5628
|
+
"type": "object",
|
|
5629
|
+
"properties": {
|
|
5630
|
+
"hashType": {
|
|
5631
|
+
"type": "string",
|
|
5632
|
+
"description": "The hash algorithm that was used."
|
|
5633
|
+
},
|
|
5634
|
+
"hash": {
|
|
5635
|
+
"type": "string",
|
|
5636
|
+
"description": "The hash value of the file."
|
|
5637
|
+
}
|
|
5638
|
+
},
|
|
5639
|
+
"required": [
|
|
5640
|
+
"hashType",
|
|
5641
|
+
"hash"
|
|
5642
|
+
]
|
|
5643
|
+
}
|
|
5644
|
+
}
|
|
5645
|
+
}
|
|
5646
|
+
},
|
|
5538
5647
|
"OperationsPubliclinkResponse": {
|
|
5539
5648
|
"description": "Public sharing URL returned by `operations/publiclink`.",
|
|
5540
5649
|
"content": {
|
package/openapi.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
openapi: 3.1.0
|
|
2
2
|
info:
|
|
3
3
|
title: Rclone RC API
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.73.0
|
|
5
5
|
description: "Full OpenAPI specification for the Rclone RC API."
|
|
6
6
|
contact:
|
|
7
7
|
name: GitHub Repository
|
|
@@ -160,6 +160,27 @@ paths:
|
|
|
160
160
|
"5XX":
|
|
161
161
|
$ref: "#/components/responses/RcError"
|
|
162
162
|
operationId: operationsHashsum
|
|
163
|
+
/operations/hashsumfile:
|
|
164
|
+
post:
|
|
165
|
+
summary: "Hash a single file"
|
|
166
|
+
description: "Returns the hash of a single file using the specified hash algorithm."
|
|
167
|
+
tags: []
|
|
168
|
+
parameters:
|
|
169
|
+
- $ref: "#/components/parameters/Operations_HashsumfilePostFsParam"
|
|
170
|
+
- $ref: "#/components/parameters/Operations_HashsumfilePostRemoteParam"
|
|
171
|
+
- $ref: "#/components/parameters/Operations_HashsumfilePostHashTypeParam"
|
|
172
|
+
- $ref: "#/components/parameters/Operations_HashsumfilePostDownloadParam"
|
|
173
|
+
- $ref: "#/components/parameters/Operations_HashsumfilePostBase64Param"
|
|
174
|
+
- $ref: "#/components/parameters/GlobalGroupParam"
|
|
175
|
+
- $ref: "#/components/parameters/GlobalAsyncParam"
|
|
176
|
+
responses:
|
|
177
|
+
"200":
|
|
178
|
+
$ref: "#/components/responses/OperationsHashsumfileResponse"
|
|
179
|
+
"4XX":
|
|
180
|
+
$ref: "#/components/responses/RcError"
|
|
181
|
+
"5XX":
|
|
182
|
+
$ref: "#/components/responses/RcError"
|
|
183
|
+
operationId: operationsHashsumfile
|
|
163
184
|
/operations/movefile:
|
|
164
185
|
post:
|
|
165
186
|
summary: "Move a single file"
|
|
@@ -1962,6 +1983,39 @@ components:
|
|
|
1962
1983
|
description: "Set to true to emit hash values in base64 rather than hexadecimal."
|
|
1963
1984
|
schema:
|
|
1964
1985
|
type: boolean
|
|
1986
|
+
Operations_HashsumfilePostFsParam:
|
|
1987
|
+
name: fs
|
|
1988
|
+
in: query
|
|
1989
|
+
description: "Remote name or path containing the file to hash."
|
|
1990
|
+
schema:
|
|
1991
|
+
type: string
|
|
1992
|
+
required: true
|
|
1993
|
+
Operations_HashsumfilePostRemoteParam:
|
|
1994
|
+
name: remote
|
|
1995
|
+
in: query
|
|
1996
|
+
description: "Path to the specific file within `fs` to hash."
|
|
1997
|
+
schema:
|
|
1998
|
+
type: string
|
|
1999
|
+
required: true
|
|
2000
|
+
Operations_HashsumfilePostHashTypeParam:
|
|
2001
|
+
name: hashType
|
|
2002
|
+
in: query
|
|
2003
|
+
description: "Hash algorithm to use, e.g. `md5`, `sha1`, or another supported name."
|
|
2004
|
+
schema:
|
|
2005
|
+
type: string
|
|
2006
|
+
required: true
|
|
2007
|
+
Operations_HashsumfilePostDownloadParam:
|
|
2008
|
+
name: download
|
|
2009
|
+
in: query
|
|
2010
|
+
description: "Set to true to force reading the data instead of using remote checksums."
|
|
2011
|
+
schema:
|
|
2012
|
+
type: boolean
|
|
2013
|
+
Operations_HashsumfilePostBase64Param:
|
|
2014
|
+
name: base64
|
|
2015
|
+
in: query
|
|
2016
|
+
description: "Set to true to emit the hash value in base64 rather than hexadecimal."
|
|
2017
|
+
schema:
|
|
2018
|
+
type: boolean
|
|
1965
2019
|
Operations_MovefilePostSrcFsParam:
|
|
1966
2020
|
name: srcFs
|
|
1967
2021
|
in: query
|
|
@@ -3214,6 +3268,22 @@ components:
|
|
|
3214
3268
|
required:
|
|
3215
3269
|
- hashType
|
|
3216
3270
|
- hashsum
|
|
3271
|
+
OperationsHashsumfileResponse:
|
|
3272
|
+
description: "Hash algorithm used and the hash value for a single file from `operations/hashsumfile`."
|
|
3273
|
+
content:
|
|
3274
|
+
application/json:
|
|
3275
|
+
schema:
|
|
3276
|
+
type: object
|
|
3277
|
+
properties:
|
|
3278
|
+
hashType:
|
|
3279
|
+
type: string
|
|
3280
|
+
description: "The hash algorithm that was used."
|
|
3281
|
+
hash:
|
|
3282
|
+
type: string
|
|
3283
|
+
description: "The hash value of the file."
|
|
3284
|
+
required:
|
|
3285
|
+
- hashType
|
|
3286
|
+
- hash
|
|
3217
3287
|
OperationsPubliclinkResponse:
|
|
3218
3288
|
description: "Public sharing URL returned by `operations/publiclink`."
|
|
3219
3289
|
content:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rclone-openapi",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.73.0",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"rclone",
|
|
6
6
|
"openapi",
|
|
@@ -35,11 +35,11 @@
|
|
|
35
35
|
"gen:types": "openapi-typescript openapi.yaml -o types.d.ts",
|
|
36
36
|
"gen": "npm run gen:json && npm run gen:types",
|
|
37
37
|
"bump": "npm version patch --no-git-tag-version",
|
|
38
|
-
"pub": "npm run gen && npm
|
|
38
|
+
"pub": "npm run gen && npm publish"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@redocly/cli": "^1.34.5",
|
|
42
42
|
"openapi-typescript": "^7.10.1",
|
|
43
|
-
"yaml": "^2.8.
|
|
43
|
+
"yaml": "^2.8.2"
|
|
44
44
|
}
|
|
45
45
|
}
|
package/types.d.ts
CHANGED
|
@@ -164,6 +164,26 @@ export interface paths {
|
|
|
164
164
|
patch?: never;
|
|
165
165
|
trace?: never;
|
|
166
166
|
};
|
|
167
|
+
"/operations/hashsumfile": {
|
|
168
|
+
parameters: {
|
|
169
|
+
query?: never;
|
|
170
|
+
header?: never;
|
|
171
|
+
path?: never;
|
|
172
|
+
cookie?: never;
|
|
173
|
+
};
|
|
174
|
+
get?: never;
|
|
175
|
+
put?: never;
|
|
176
|
+
/**
|
|
177
|
+
* Hash a single file
|
|
178
|
+
* @description Returns the hash of a single file using the specified hash algorithm.
|
|
179
|
+
*/
|
|
180
|
+
post: operations["operationsHashsumfile"];
|
|
181
|
+
delete?: never;
|
|
182
|
+
options?: never;
|
|
183
|
+
head?: never;
|
|
184
|
+
patch?: never;
|
|
185
|
+
trace?: never;
|
|
186
|
+
};
|
|
167
187
|
"/operations/movefile": {
|
|
168
188
|
parameters: {
|
|
169
189
|
query?: never;
|
|
@@ -2160,6 +2180,20 @@ export interface components {
|
|
|
2160
2180
|
};
|
|
2161
2181
|
};
|
|
2162
2182
|
};
|
|
2183
|
+
/** @description Hash algorithm used and the hash value for a single file from `operations/hashsumfile`. */
|
|
2184
|
+
OperationsHashsumfileResponse: {
|
|
2185
|
+
headers: {
|
|
2186
|
+
[name: string]: unknown;
|
|
2187
|
+
};
|
|
2188
|
+
content: {
|
|
2189
|
+
"application/json": {
|
|
2190
|
+
/** @description The hash algorithm that was used. */
|
|
2191
|
+
hashType: string;
|
|
2192
|
+
/** @description The hash value of the file. */
|
|
2193
|
+
hash: string;
|
|
2194
|
+
};
|
|
2195
|
+
};
|
|
2196
|
+
};
|
|
2163
2197
|
/** @description Public sharing URL returned by `operations/publiclink`. */
|
|
2164
2198
|
OperationsPubliclinkResponse: {
|
|
2165
2199
|
headers: {
|
|
@@ -3171,6 +3205,16 @@ export interface components {
|
|
|
3171
3205
|
Operations_HashsumPostDownloadParam: boolean;
|
|
3172
3206
|
/** @description Set to true to emit hash values in base64 rather than hexadecimal. */
|
|
3173
3207
|
Operations_HashsumPostBase64Param: boolean;
|
|
3208
|
+
/** @description Remote name or path containing the file to hash. */
|
|
3209
|
+
Operations_HashsumfilePostFsParam: string;
|
|
3210
|
+
/** @description Path to the specific file within `fs` to hash. */
|
|
3211
|
+
Operations_HashsumfilePostRemoteParam: string;
|
|
3212
|
+
/** @description Hash algorithm to use, e.g. `md5`, `sha1`, or another supported name. */
|
|
3213
|
+
Operations_HashsumfilePostHashTypeParam: string;
|
|
3214
|
+
/** @description Set to true to force reading the data instead of using remote checksums. */
|
|
3215
|
+
Operations_HashsumfilePostDownloadParam: boolean;
|
|
3216
|
+
/** @description Set to true to emit the hash value in base64 rather than hexadecimal. */
|
|
3217
|
+
Operations_HashsumfilePostBase64Param: boolean;
|
|
3174
3218
|
/** @description Source remote name or path containing the file to move. */
|
|
3175
3219
|
Operations_MovefilePostSrcFsParam: string;
|
|
3176
3220
|
/** @description Path to the source object within `srcFs`. */
|
|
@@ -3772,6 +3816,35 @@ export interface operations {
|
|
|
3772
3816
|
"5XX": components["responses"]["RcError"];
|
|
3773
3817
|
};
|
|
3774
3818
|
};
|
|
3819
|
+
operationsHashsumfile: {
|
|
3820
|
+
parameters: {
|
|
3821
|
+
query: {
|
|
3822
|
+
/** @description Remote name or path containing the file to hash. */
|
|
3823
|
+
fs: components["parameters"]["Operations_HashsumfilePostFsParam"];
|
|
3824
|
+
/** @description Path to the specific file within `fs` to hash. */
|
|
3825
|
+
remote: components["parameters"]["Operations_HashsumfilePostRemoteParam"];
|
|
3826
|
+
/** @description Hash algorithm to use, e.g. `md5`, `sha1`, or another supported name. */
|
|
3827
|
+
hashType: components["parameters"]["Operations_HashsumfilePostHashTypeParam"];
|
|
3828
|
+
/** @description Set to true to force reading the data instead of using remote checksums. */
|
|
3829
|
+
download?: components["parameters"]["Operations_HashsumfilePostDownloadParam"];
|
|
3830
|
+
/** @description Set to true to emit the hash value in base64 rather than hexadecimal. */
|
|
3831
|
+
base64?: components["parameters"]["Operations_HashsumfilePostBase64Param"];
|
|
3832
|
+
/** @description Assign the request to a custom stats group. */
|
|
3833
|
+
_group?: components["parameters"]["GlobalGroupParam"];
|
|
3834
|
+
/** @description Run the command asynchronously. Returns a job id immediately. */
|
|
3835
|
+
_async?: components["parameters"]["GlobalAsyncParam"];
|
|
3836
|
+
};
|
|
3837
|
+
header?: never;
|
|
3838
|
+
path?: never;
|
|
3839
|
+
cookie?: never;
|
|
3840
|
+
};
|
|
3841
|
+
requestBody?: never;
|
|
3842
|
+
responses: {
|
|
3843
|
+
200: components["responses"]["OperationsHashsumfileResponse"];
|
|
3844
|
+
"4XX": components["responses"]["RcError"];
|
|
3845
|
+
"5XX": components["responses"]["RcError"];
|
|
3846
|
+
};
|
|
3847
|
+
};
|
|
3775
3848
|
operationsMovefile: {
|
|
3776
3849
|
parameters: {
|
|
3777
3850
|
query: {
|