rclone-openapi 1.0.3 → 1.0.5

package/openapi.json

@@ -1746,6 +1746,12 @@
         "description": "Returns active transfer statistics including bytes transferred, speed, and error counts.",
         "tags": [],
         "parameters": [
+          {
+            "$ref": "#/components/parameters/Core_StatsPostGroupParam"
+          },
+          {
+            "$ref": "#/components/parameters/Core_StatsPostShortParam"
+          },
           {
             "$ref": "#/components/parameters/GlobalGroupParam"
           },
@@ -3482,6 +3488,22 @@
         },
         "required": true
       },
+      "Core_StatsPostGroupParam": {
+        "name": "group",
+        "in": "query",
+        "description": "Stats group identifier to return a snapshot for. Leave unset to include all groups.",
+        "schema": {
+          "type": "string"
+        }
+      },
+      "Core_StatsPostShortParam": {
+        "name": "short",
+        "in": "query",
+        "description": "When true, omit the `transferring` and `checking` arrays from the response.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
       "Core_StatsResetPostGroupParam": {
         "name": "group",
         "in": "query",
@@ -4796,6 +4818,26 @@
                   "items": {
                     "type": "object",
                     "properties": {
+                      "group": {
+                        "type": "string",
+                        "description": "Stats group identifier this transfer belonged to."
+                      },
+                      "srcFs": {
+                        "type": "string",
+                        "description": "Source remote or filesystem used for the transfer."
+                      },
+                      "dstFs": {
+                        "type": "string",
+                        "description": "Destination remote or filesystem used for the transfer."
+                      },
+                      "srcRemote": {
+                        "type": "string",
+                        "description": "Source path within `srcFs`, when provided."
+                      },
+                      "dstRemote": {
+                        "type": "string",
+                        "description": "Destination path within `dstFs`, when provided."
+                      },
                       "name": {
                         "type": "string"
                       },
@@ -4821,7 +4863,10 @@
                         "type": "integer"
                       }
                     },
-                    "additionalProperties": false
+                    "additionalProperties": true,
+                    "required": [
+                      "group"
+                    ]
                   }
                 }
               },
@@ -5262,6 +5307,20 @@
                 },
                 "transfers": {
                   "type": "number"
+                },
+                "transferring": {
+                  "type": "array",
+                  "description": "Active transfers currently in progress grouped by stats group.",
+                  "items": {
+                    "$ref": "#/components/schemas/CoreStatsTransfer"
+                  }
+                },
+                "checking": {
+                  "type": "array",
+                  "description": "Objects currently undergoing verification operations.",
+                  "items": {
+                    "$ref": "#/components/schemas/CoreStatsChecking"
+                  }
                 }
               },
               "required": [
@@ -6977,6 +7036,61 @@
           "Time",
           "Tristate"
         ]
+      },
+      "CoreStatsTransfer": {
+        "type": "object",
+        "description": "Progress metrics for an in-flight transfer.",
+        "properties": {
+          "bytes": {
+            "type": "number",
+            "description": "Bytes transferred so far for this object."
+          },
+          "eta": {
+            "type": "number",
+            "nullable": true,
+            "description": "Estimated seconds remaining, when available."
+          },
+          "group": {
+            "type": "string",
+            "description": "Stats group name associated with this transfer."
+          },
+          "name": {
+            "type": "string",
+            "description": "Remote path of the object being transferred."
+          },
+          "percentage": {
+            "type": "number",
+            "description": "Completion percentage from 0-100."
+          },
+          "size": {
+            "type": "number",
+            "description": "Total size in bytes of the object."
+          },
+          "speed": {
+            "type": "number",
+            "description": "Current transfer speed in bytes per second."
+          }
+        },
+        "additionalProperties": true
+      },
+      "CoreStatsChecking": {
+        "type": "object",
+        "description": "Metadata for an item currently undergoing verification.",
+        "properties": {
+          "group": {
+            "type": "string",
+            "description": "Stats group name associated with this verification."
+          },
+          "name": {
+            "type": "string",
+            "description": "Remote path of the object being verified."
+          },
+          "size": {
+            "type": "number",
+            "description": "Total size in bytes of the object."
+          }
+        },
+        "additionalProperties": true
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rclone-openapi",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "keywords": [
     "rclone",
     "openapi",
@@ -32,7 +32,8 @@
   "scripts": {
     "gen:json": "npx @redocly/cli bundle openapi.yaml -o openapi.json --ext json",
     "gen:types": "openapi-typescript openapi.yaml -o types.d.ts",
-    "gen": "npm run gen:json && npm run gen:types"
+    "gen": "npm run gen:json && npm run gen:types",
+	"pub": "npm run gen && npm publish"
   },
   "devDependencies": {
     "@redocly/cli": "^1.34.5",

package/types.d.ts

@@ -2300,6 +2300,10 @@ export interface paths {
         post: {
             parameters: {
                 query?: {
+                    /** @description Stats group identifier to return a snapshot for. Leave unset to include all groups. */
+                    group?: components["parameters"]["Core_StatsPostGroupParam"];
+                    /** @description When true, omit the `transferring` and `checking` arrays from the response. */
+                    short?: components["parameters"]["Core_StatsPostShortParam"];
                     /** @description Assign the request to a custom stats group. */
                     _group?: components["parameters"]["GlobalGroupParam"];
                     /** @description Run the command asynchronously. Returns a job id immediately. */
@@ -4085,6 +4089,36 @@ export interface components {
         } | 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. */
+        CoreStatsTransfer: {
+            /** @description Bytes transferred so far for this object. */
+            bytes?: number;
+            /** @description Estimated seconds remaining, when available. */
+            eta?: number | null;
+            /** @description Stats group name associated with this transfer. */
+            group?: string;
+            /** @description Remote path of the object being transferred. */
+            name?: string;
+            /** @description Completion percentage from 0-100. */
+            percentage?: number;
+            /** @description Total size in bytes of the object. */
+            size?: number;
+            /** @description Current transfer speed in bytes per second. */
+            speed?: number;
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description Metadata for an item currently undergoing verification. */
+        CoreStatsChecking: {
+            /** @description Stats group name associated with this verification. */
+            group?: string;
+            /** @description Remote path of the object being verified. */
+            name?: string;
+            /** @description Total size in bytes of the object. */
+            size?: number;
+        } & {
+            [key: string]: unknown;
+        };
     };
     responses: {
         /** @description Any error response (HTTP 4xx/5xx) */
@@ -4231,7 +4265,17 @@ export interface components {
             };
             content: {
                 "application/json": {
-                    transferred: {
+                    transferred: ({
+                        /** @description Stats group identifier this transfer belonged to. */
+                        group: string;
+                        /** @description Source remote or filesystem used for the transfer. */
+                        srcFs?: string;
+                        /** @description Destination remote or filesystem used for the transfer. */
+                        dstFs?: string;
+                        /** @description Source path within `srcFs`, when provided. */
+                        srcRemote?: string;
+                        /** @description Destination path within `dstFs`, when provided. */
+                        dstRemote?: string;
                         name?: string;
                         size?: number;
                         bytes?: number;
@@ -4240,7 +4284,9 @@ export interface components {
                         timestamp?: number;
                         error?: string;
                         jobid?: number;
-                    }[];
+                    } & {
+                        [key: string]: unknown;
+                    })[];
                 };
             };
         };
@@ -4469,6 +4515,10 @@ export interface components {
                     totalTransfers: number;
                     transferTime: number;
                     transfers: number;
+                    /** @description Active transfers currently in progress grouped by stats group. */
+                    transferring?: components["schemas"]["CoreStatsTransfer"][];
+                    /** @description Objects currently undergoing verification operations. */
+                    checking?: components["schemas"]["CoreStatsChecking"][];
                 };
             };
         };
@@ -5156,6 +5206,10 @@ export interface components {
         Core_QuitPostExitCodeParam: number;
         /** @description Stats group identifier to remove. */
         Core_StatsDeletePostGroupParam: string;
+        /** @description Stats group identifier to return a snapshot for. Leave unset to include all groups. */
+        Core_StatsPostGroupParam: string;
+        /** @description When true, omit the `transferring` and `checking` arrays from the response. */
+        Core_StatsPostShortParam: boolean;
         /** @description Stats group identifier whose counters should be reset. Leave unset to reset all groups. */
         Core_StatsResetPostGroupParam: string;
         /** @description Stats group identifier to filter the completed transfer list. Leave unset for all groups. */