rclone-openapi 1.0.4 → 1.0.6

package/openapi.json

@@ -1888,6 +1888,36 @@
           {
             "$ref": "#/components/parameters/Operations_ListPostOptParam"
           },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostRecurseParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostNoModTimeParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostShowEncryptedParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostShowOrigIDsParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostShowHashParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostNoMimeTypeParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostDirsOnlyParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostFilesOnlyParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostMetadataParam"
+          },
+          {
+            "$ref": "#/components/parameters/Operations_ListPostHashTypesParam"
+          },
           {
             "$ref": "#/components/parameters/GlobalGroupParam"
           },
@@ -3866,7 +3896,92 @@
         "schema": {
           "type": "string"
         },
-        "description": "Optional JSON object of listing flags (e.g. `{ \"recurse\": true, \"showHash\": true }`)."
+        "description": "Optional JSON-encoded object of listing flags (e.g. `{ \"recurse\": true, \"showHash\": true }`)."
+      },
+      "Operations_ListPostRecurseParam": {
+        "name": "recurse",
+        "in": "query",
+        "description": "Set to true to list directories recursively.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostNoModTimeParam": {
+        "name": "noModTime",
+        "in": "query",
+        "description": "Set to true to omit modification times for faster listings on some backends.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostShowEncryptedParam": {
+        "name": "showEncrypted",
+        "in": "query",
+        "description": "Set to true to include encrypted names when using crypt remotes.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostShowOrigIDsParam": {
+        "name": "showOrigIDs",
+        "in": "query",
+        "description": "Set to true to include original backend identifiers where available.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostShowHashParam": {
+        "name": "showHash",
+        "in": "query",
+        "description": "Set to true to include hash digests for each entry.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostNoMimeTypeParam": {
+        "name": "noMimeType",
+        "in": "query",
+        "description": "Set to true to omit MIME type detection.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostDirsOnlyParam": {
+        "name": "dirsOnly",
+        "in": "query",
+        "description": "Set to true to return only directory entries.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostFilesOnlyParam": {
+        "name": "filesOnly",
+        "in": "query",
+        "description": "Set to true to return only file entries.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostMetadataParam": {
+        "name": "metadata",
+        "in": "query",
+        "description": "Set to true to include backend-provided metadata maps.",
+        "schema": {
+          "type": "boolean"
+        }
+      },
+      "Operations_ListPostHashTypesParam": {
+        "name": "hashTypes",
+        "in": "query",
+        "description": "Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`).",
+        "schema": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "style": "form",
+        "explode": true
       },
       "Operations_StatPostFsParam": {
         "name": "fs",
@@ -4818,6 +4933,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"
                       },
@@ -4843,7 +4978,10 @@
                         "type": "integer"
                       }
                     },
-                    "additionalProperties": false
+                    "additionalProperties": true,
+                    "required": [
+                      "group"
+                    ]
                   }
                 }
               },
@@ -5524,8 +5662,14 @@
               "properties": {
                 "list": {
                   "type": "array",
+                  "description": "Array of entries equivalent to the items returned by `rclone lsjson`.",
                   "items": {
                     "type": "object",
+                    "required": [
+                      "Path",
+                      "Name",
+                      "IsDir"
+                    ],
                     "properties": {
                       "Path": {
                         "type": "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rclone-openapi",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "keywords": [
     "rclone",
     "openapi",

package/types.d.ts

@@ -2496,8 +2496,28 @@ export interface paths {
                     fs: components["parameters"]["Operations_ListPostFsParam"];
                     /** @description Directory path within `fs` to list; leave empty to target the root. */
                     remote: components["parameters"]["Operations_ListPostRemoteParam"];
-                    /** @description Optional JSON object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
+                    /** @description Optional JSON-encoded object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
                     opt?: components["parameters"]["Operations_ListPostOptParam"];
+                    /** @description Set to true to list directories recursively. */
+                    recurse?: components["parameters"]["Operations_ListPostRecurseParam"];
+                    /** @description Set to true to omit modification times for faster listings on some backends. */
+                    noModTime?: components["parameters"]["Operations_ListPostNoModTimeParam"];
+                    /** @description Set to true to include encrypted names when using crypt remotes. */
+                    showEncrypted?: components["parameters"]["Operations_ListPostShowEncryptedParam"];
+                    /** @description Set to true to include original backend identifiers where available. */
+                    showOrigIDs?: components["parameters"]["Operations_ListPostShowOrigIDsParam"];
+                    /** @description Set to true to include hash digests for each entry. */
+                    showHash?: components["parameters"]["Operations_ListPostShowHashParam"];
+                    /** @description Set to true to omit MIME type detection. */
+                    noMimeType?: components["parameters"]["Operations_ListPostNoMimeTypeParam"];
+                    /** @description Set to true to return only directory entries. */
+                    dirsOnly?: components["parameters"]["Operations_ListPostDirsOnlyParam"];
+                    /** @description Set to true to return only file entries. */
+                    filesOnly?: components["parameters"]["Operations_ListPostFilesOnlyParam"];
+                    /** @description Set to true to include backend-provided metadata maps. */
+                    metadata?: components["parameters"]["Operations_ListPostMetadataParam"];
+                    /** @description Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`). */
+                    hashTypes?: components["parameters"]["Operations_ListPostHashTypesParam"];
                     /** @description Assign the request to a custom stats group. */
                     _group?: components["parameters"]["GlobalGroupParam"];
                     /** @description Run the command asynchronously. Returns a job id immediately. */
@@ -4265,7 +4285,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;
@@ -4274,7 +4304,9 @@ export interface components {
                         timestamp?: number;
                         error?: string;
                         jobid?: number;
-                    }[];
+                    } & {
+                        [key: string]: unknown;
+                    })[];
                 };
             };
         };
@@ -4603,11 +4635,12 @@ export interface components {
             };
             content: {
                 "application/json": {
+                    /** @description Array of entries equivalent to the items returned by `rclone lsjson`. */
                     list: {
                         /** @description Path relative to the requested remote root. */
-                        Path?: string;
+                        Path: string;
                         /** @description Base name of the entry. */
-                        Name?: string;
+                        Name: string;
                         /** @description Object size in bytes. */
                         Size?: number;
                         /** @description MIME type where available. */
@@ -4615,7 +4648,7 @@ export interface components {
                         /** @description Modification timestamp in RFC3339 format. */
                         ModTime?: string;
                         /** @description True if the entry represents a directory. */
-                        IsDir?: boolean;
+                        IsDir: boolean;
                         /** @description Hash digests keyed by algorithm when requested. */
                         Hashes?: {
                             [key: string]: string;
@@ -5278,8 +5311,28 @@ export interface components {
         Operations_ListPostFsParam: string;
         /** @description Directory path within `fs` to list; leave empty to target the root. */
         Operations_ListPostRemoteParam: string;
-        /** @description Optional JSON object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
+        /** @description Optional JSON-encoded object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
         Operations_ListPostOptParam: string;
+        /** @description Set to true to list directories recursively. */
+        Operations_ListPostRecurseParam: boolean;
+        /** @description Set to true to omit modification times for faster listings on some backends. */
+        Operations_ListPostNoModTimeParam: boolean;
+        /** @description Set to true to include encrypted names when using crypt remotes. */
+        Operations_ListPostShowEncryptedParam: boolean;
+        /** @description Set to true to include original backend identifiers where available. */
+        Operations_ListPostShowOrigIDsParam: boolean;
+        /** @description Set to true to include hash digests for each entry. */
+        Operations_ListPostShowHashParam: boolean;
+        /** @description Set to true to omit MIME type detection. */
+        Operations_ListPostNoMimeTypeParam: boolean;
+        /** @description Set to true to return only directory entries. */
+        Operations_ListPostDirsOnlyParam: boolean;
+        /** @description Set to true to return only file entries. */
+        Operations_ListPostFilesOnlyParam: boolean;
+        /** @description Set to true to include backend-provided metadata maps. */
+        Operations_ListPostMetadataParam: boolean;
+        /** @description Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`). */
+        Operations_ListPostHashTypesParam: string[];
         /** @description Remote name or path that contains the item to inspect. */
         Operations_StatPostFsParam: string;
         /** @description Path to the file or directory within `fs` to describe. */