rclone-openapi 1.0.3 → 1.0.4
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 +91 -0
- package/package.json +3 -2
- package/types.d.ts +42 -0
package/openapi.json
CHANGED
|
@@ -1746,6 +1746,12 @@
|
|
|
1746
1746
|
"description": "Returns active transfer statistics including bytes transferred, speed, and error counts.",
|
|
1747
1747
|
"tags": [],
|
|
1748
1748
|
"parameters": [
|
|
1749
|
+
{
|
|
1750
|
+
"$ref": "#/components/parameters/Core_StatsPostGroupParam"
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"$ref": "#/components/parameters/Core_StatsPostShortParam"
|
|
1754
|
+
},
|
|
1749
1755
|
{
|
|
1750
1756
|
"$ref": "#/components/parameters/GlobalGroupParam"
|
|
1751
1757
|
},
|
|
@@ -3482,6 +3488,22 @@
|
|
|
3482
3488
|
},
|
|
3483
3489
|
"required": true
|
|
3484
3490
|
},
|
|
3491
|
+
"Core_StatsPostGroupParam": {
|
|
3492
|
+
"name": "group",
|
|
3493
|
+
"in": "query",
|
|
3494
|
+
"description": "Stats group identifier to return a snapshot for. Leave unset to include all groups.",
|
|
3495
|
+
"schema": {
|
|
3496
|
+
"type": "string"
|
|
3497
|
+
}
|
|
3498
|
+
},
|
|
3499
|
+
"Core_StatsPostShortParam": {
|
|
3500
|
+
"name": "short",
|
|
3501
|
+
"in": "query",
|
|
3502
|
+
"description": "When true, omit the `transferring` and `checking` arrays from the response.",
|
|
3503
|
+
"schema": {
|
|
3504
|
+
"type": "boolean"
|
|
3505
|
+
}
|
|
3506
|
+
},
|
|
3485
3507
|
"Core_StatsResetPostGroupParam": {
|
|
3486
3508
|
"name": "group",
|
|
3487
3509
|
"in": "query",
|
|
@@ -5262,6 +5284,20 @@
|
|
|
5262
5284
|
},
|
|
5263
5285
|
"transfers": {
|
|
5264
5286
|
"type": "number"
|
|
5287
|
+
},
|
|
5288
|
+
"transferring": {
|
|
5289
|
+
"type": "array",
|
|
5290
|
+
"description": "Active transfers currently in progress grouped by stats group.",
|
|
5291
|
+
"items": {
|
|
5292
|
+
"$ref": "#/components/schemas/CoreStatsTransfer"
|
|
5293
|
+
}
|
|
5294
|
+
},
|
|
5295
|
+
"checking": {
|
|
5296
|
+
"type": "array",
|
|
5297
|
+
"description": "Objects currently undergoing verification operations.",
|
|
5298
|
+
"items": {
|
|
5299
|
+
"$ref": "#/components/schemas/CoreStatsChecking"
|
|
5300
|
+
}
|
|
5265
5301
|
}
|
|
5266
5302
|
},
|
|
5267
5303
|
"required": [
|
|
@@ -6977,6 +7013,61 @@
|
|
|
6977
7013
|
"Time",
|
|
6978
7014
|
"Tristate"
|
|
6979
7015
|
]
|
|
7016
|
+
},
|
|
7017
|
+
"CoreStatsTransfer": {
|
|
7018
|
+
"type": "object",
|
|
7019
|
+
"description": "Progress metrics for an in-flight transfer.",
|
|
7020
|
+
"properties": {
|
|
7021
|
+
"bytes": {
|
|
7022
|
+
"type": "number",
|
|
7023
|
+
"description": "Bytes transferred so far for this object."
|
|
7024
|
+
},
|
|
7025
|
+
"eta": {
|
|
7026
|
+
"type": "number",
|
|
7027
|
+
"nullable": true,
|
|
7028
|
+
"description": "Estimated seconds remaining, when available."
|
|
7029
|
+
},
|
|
7030
|
+
"group": {
|
|
7031
|
+
"type": "string",
|
|
7032
|
+
"description": "Stats group name associated with this transfer."
|
|
7033
|
+
},
|
|
7034
|
+
"name": {
|
|
7035
|
+
"type": "string",
|
|
7036
|
+
"description": "Remote path of the object being transferred."
|
|
7037
|
+
},
|
|
7038
|
+
"percentage": {
|
|
7039
|
+
"type": "number",
|
|
7040
|
+
"description": "Completion percentage from 0-100."
|
|
7041
|
+
},
|
|
7042
|
+
"size": {
|
|
7043
|
+
"type": "number",
|
|
7044
|
+
"description": "Total size in bytes of the object."
|
|
7045
|
+
},
|
|
7046
|
+
"speed": {
|
|
7047
|
+
"type": "number",
|
|
7048
|
+
"description": "Current transfer speed in bytes per second."
|
|
7049
|
+
}
|
|
7050
|
+
},
|
|
7051
|
+
"additionalProperties": true
|
|
7052
|
+
},
|
|
7053
|
+
"CoreStatsChecking": {
|
|
7054
|
+
"type": "object",
|
|
7055
|
+
"description": "Metadata for an item currently undergoing verification.",
|
|
7056
|
+
"properties": {
|
|
7057
|
+
"group": {
|
|
7058
|
+
"type": "string",
|
|
7059
|
+
"description": "Stats group name associated with this verification."
|
|
7060
|
+
},
|
|
7061
|
+
"name": {
|
|
7062
|
+
"type": "string",
|
|
7063
|
+
"description": "Remote path of the object being verified."
|
|
7064
|
+
},
|
|
7065
|
+
"size": {
|
|
7066
|
+
"type": "number",
|
|
7067
|
+
"description": "Total size in bytes of the object."
|
|
7068
|
+
}
|
|
7069
|
+
},
|
|
7070
|
+
"additionalProperties": true
|
|
6980
7071
|
}
|
|
6981
7072
|
}
|
|
6982
7073
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rclone-openapi",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"keywords": [
|
|
5
5
|
"rclone",
|
|
6
6
|
"openapi",
|
|
@@ -32,7 +32,8 @@
|
|
|
32
32
|
"scripts": {
|
|
33
33
|
"gen:json": "npx @redocly/cli bundle openapi.yaml -o openapi.json --ext json",
|
|
34
34
|
"gen:types": "openapi-typescript openapi.yaml -o types.d.ts",
|
|
35
|
-
"gen": "npm run gen:json && npm run gen:types"
|
|
35
|
+
"gen": "npm run gen:json && npm run gen:types",
|
|
36
|
+
"pub": "npm run gen && npm publish"
|
|
36
37
|
},
|
|
37
38
|
"devDependencies": {
|
|
38
39
|
"@redocly/cli": "^1.34.5",
|
package/types.d.ts
CHANGED
|
@@ -2300,6 +2300,10 @@ export interface paths {
|
|
|
2300
2300
|
post: {
|
|
2301
2301
|
parameters: {
|
|
2302
2302
|
query?: {
|
|
2303
|
+
/** @description Stats group identifier to return a snapshot for. Leave unset to include all groups. */
|
|
2304
|
+
group?: components["parameters"]["Core_StatsPostGroupParam"];
|
|
2305
|
+
/** @description When true, omit the `transferring` and `checking` arrays from the response. */
|
|
2306
|
+
short?: components["parameters"]["Core_StatsPostShortParam"];
|
|
2303
2307
|
/** @description Assign the request to a custom stats group. */
|
|
2304
2308
|
_group?: components["parameters"]["GlobalGroupParam"];
|
|
2305
2309
|
/** @description Run the command asynchronously. Returns a job id immediately. */
|
|
@@ -4085,6 +4089,36 @@ export interface components {
|
|
|
4085
4089
|
} | null;
|
|
4086
4090
|
/** @enum {string} */
|
|
4087
4091
|
ConfigProviderOptionType: "Bits" | "bool" | "CommaSepList" | "Duration" | "Encoding" | "int" | "mtime|atime|btime|ctime" | "SizeSuffix" | "SpaceSepList" | "string" | "stringArray" | "Time" | "Tristate";
|
|
4092
|
+
/** @description Progress metrics for an in-flight transfer. */
|
|
4093
|
+
CoreStatsTransfer: {
|
|
4094
|
+
/** @description Bytes transferred so far for this object. */
|
|
4095
|
+
bytes?: number;
|
|
4096
|
+
/** @description Estimated seconds remaining, when available. */
|
|
4097
|
+
eta?: number | null;
|
|
4098
|
+
/** @description Stats group name associated with this transfer. */
|
|
4099
|
+
group?: string;
|
|
4100
|
+
/** @description Remote path of the object being transferred. */
|
|
4101
|
+
name?: string;
|
|
4102
|
+
/** @description Completion percentage from 0-100. */
|
|
4103
|
+
percentage?: number;
|
|
4104
|
+
/** @description Total size in bytes of the object. */
|
|
4105
|
+
size?: number;
|
|
4106
|
+
/** @description Current transfer speed in bytes per second. */
|
|
4107
|
+
speed?: number;
|
|
4108
|
+
} & {
|
|
4109
|
+
[key: string]: unknown;
|
|
4110
|
+
};
|
|
4111
|
+
/** @description Metadata for an item currently undergoing verification. */
|
|
4112
|
+
CoreStatsChecking: {
|
|
4113
|
+
/** @description Stats group name associated with this verification. */
|
|
4114
|
+
group?: string;
|
|
4115
|
+
/** @description Remote path of the object being verified. */
|
|
4116
|
+
name?: string;
|
|
4117
|
+
/** @description Total size in bytes of the object. */
|
|
4118
|
+
size?: number;
|
|
4119
|
+
} & {
|
|
4120
|
+
[key: string]: unknown;
|
|
4121
|
+
};
|
|
4088
4122
|
};
|
|
4089
4123
|
responses: {
|
|
4090
4124
|
/** @description Any error response (HTTP 4xx/5xx) */
|
|
@@ -4469,6 +4503,10 @@ export interface components {
|
|
|
4469
4503
|
totalTransfers: number;
|
|
4470
4504
|
transferTime: number;
|
|
4471
4505
|
transfers: number;
|
|
4506
|
+
/** @description Active transfers currently in progress grouped by stats group. */
|
|
4507
|
+
transferring?: components["schemas"]["CoreStatsTransfer"][];
|
|
4508
|
+
/** @description Objects currently undergoing verification operations. */
|
|
4509
|
+
checking?: components["schemas"]["CoreStatsChecking"][];
|
|
4472
4510
|
};
|
|
4473
4511
|
};
|
|
4474
4512
|
};
|
|
@@ -5156,6 +5194,10 @@ export interface components {
|
|
|
5156
5194
|
Core_QuitPostExitCodeParam: number;
|
|
5157
5195
|
/** @description Stats group identifier to remove. */
|
|
5158
5196
|
Core_StatsDeletePostGroupParam: string;
|
|
5197
|
+
/** @description Stats group identifier to return a snapshot for. Leave unset to include all groups. */
|
|
5198
|
+
Core_StatsPostGroupParam: string;
|
|
5199
|
+
/** @description When true, omit the `transferring` and `checking` arrays from the response. */
|
|
5200
|
+
Core_StatsPostShortParam: boolean;
|
|
5159
5201
|
/** @description Stats group identifier whose counters should be reset. Leave unset to reset all groups. */
|
|
5160
5202
|
Core_StatsResetPostGroupParam: string;
|
|
5161
5203
|
/** @description Stats group identifier to filter the completed transfer list. Leave unset for all groups. */
|