rclone-openapi 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 rclone-ui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "Rclone RC API",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "Full OpenAPI specification for the Rclone RC API.",
     "contact": {
       "name": "GitHub Repository",
@@ -5045,9 +5045,18 @@
           "application/json": {
             "schema": {
               "type": "object",
-              "additionalProperties": {
-                "type": "string"
-              }
+              "required": [
+                "type"
+              ],
+              "properties": {
+                "type": {
+                  "type": "string"
+                },
+                "provider": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": true
             }
           }
         }
@@ -5109,14 +5118,11 @@
                 "providers": {
                   "type": "array",
                   "items": {
-                    "type": "object",
-                    "additionalProperties": true
+                    "$ref": "#/components/schemas/ConfigProvider"
                   }
                 }
               },
-              "required": [
-                "providers"
-              ]
+              "additionalProperties": true
             }
           }
         }
@@ -5664,10 +5670,86 @@
           "application/json": {
             "schema": {
               "type": "object",
-              "additionalProperties": {
-                "type": "object",
-                "additionalProperties": true
-              }
+              "required": [
+                "dlna",
+                "filter",
+                "ftp",
+                "http",
+                "log",
+                "main",
+                "mount",
+                "nfs",
+                "proxy",
+                "rc",
+                "restic",
+                "s3",
+                "sftp",
+                "vfs",
+                "webdav"
+              ],
+              "properties": {
+                "dlna": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "filter": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "ftp": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "http": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "log": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "main": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "mount": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "nfs": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "proxy": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "rc": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "restic": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "s3": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "sftp": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "vfs": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "webdav": {
+                  "type": "object",
+                  "additionalProperties": true
+                }
+              },
+              "additionalProperties": true
             }
           }
         }
@@ -6325,6 +6407,27 @@
                       },
                       "params": {
                         "type": "object",
+                        "required": [
+                          "id",
+                          "fs",
+                          "type"
+                        ],
+                        "properties": {
+                          "fs": {
+                            "type": "string"
+                          },
+                          "type": {
+                            "type": "string"
+                          },
+                          "opt": {
+                            "type": "object",
+                            "additionalProperties": true
+                          },
+                          "vfsOpt": {
+                            "type": "object",
+                            "additionalProperties": true
+                          }
+                        },
                         "additionalProperties": true,
                         "description": "Serve configuration parameters supplied at startup."
                       }
@@ -6621,6 +6724,238 @@
             "description": "Original request parameters echoed for debugging."
           }
         }
+      },
+      "ConfigProvider": {
+        "type": "object",
+        "properties": {
+          "Aliases": {
+            "type": "array",
+            "nullable": true,
+            "items": {
+              "type": "string"
+            }
+          },
+          "CommandHelp": {
+            "type": "array",
+            "nullable": true,
+            "items": {
+              "$ref": "#/components/schemas/ConfigProviderCommandHelp"
+            }
+          },
+          "Description": {
+            "type": "string"
+          },
+          "Hide": {
+            "type": "boolean"
+          },
+          "MetadataInfo": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/ConfigProviderMetadataInfo"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "Name": {
+            "type": "string"
+          },
+          "Options": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConfigProviderOption"
+            }
+          },
+          "Prefix": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": true
+      },
+      "ConfigProviderCommandHelp": {
+        "type": "object",
+        "properties": {
+          "Long": {
+            "type": "string"
+          },
+          "Name": {
+            "type": "string"
+          },
+          "Opts": {
+            "type": "object",
+            "nullable": true,
+            "additionalProperties": true
+          },
+          "Short": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": true
+      },
+      "ConfigProviderMetadataInfo": {
+        "type": "object",
+        "properties": {
+          "Help": {
+            "type": "string"
+          },
+          "System": {
+            "type": "object",
+            "nullable": true,
+            "additionalProperties": {
+              "$ref": "#/components/schemas/ConfigProviderMetadataSystemEntry"
+            }
+          }
+        },
+        "additionalProperties": true
+      },
+      "ConfigProviderMetadataSystemEntry": {
+        "type": "object",
+        "properties": {
+          "Example": {
+            "type": "string"
+          },
+          "Help": {
+            "type": "string"
+          },
+          "ReadOnly": {
+            "type": "boolean"
+          },
+          "Type": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": true
+      },
+      "ConfigProviderOption": {
+        "type": "object",
+        "properties": {
+          "Advanced": {
+            "type": "boolean"
+          },
+          "Default": {
+            "oneOf": [
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "string"
+              },
+              {
+                "$ref": "#/components/schemas/ConfigProviderOptionDefaultObject"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "DefaultStr": {
+            "type": "string"
+          },
+          "Exclusive": {
+            "type": "boolean"
+          },
+          "FieldName": {
+            "type": "string"
+          },
+          "Help": {
+            "type": "string"
+          },
+          "Hide": {
+            "type": "number"
+          },
+          "IsPassword": {
+            "type": "boolean"
+          },
+          "Name": {
+            "type": "string"
+          },
+          "NoPrefix": {
+            "type": "boolean"
+          },
+          "Required": {
+            "type": "boolean"
+          },
+          "Sensitive": {
+            "type": "boolean"
+          },
+          "Type": {
+            "$ref": "#/components/schemas/ConfigProviderOptionType"
+          },
+          "Value": {
+            "type": "null"
+          },
+          "ValueStr": {
+            "type": "string"
+          },
+          "Examples": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConfigProviderOptionExample"
+            }
+          },
+          "ShortOpt": {
+            "type": "string"
+          },
+          "Provider": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": true
+      },
+      "ConfigProviderOptionDefaultObject": {
+        "type": "object",
+        "properties": {
+          "Valid": {
+            "type": "boolean"
+          },
+          "Value": {
+            "type": "boolean"
+          }
+        },
+        "additionalProperties": false
+      },
+      "ConfigProviderOptionExample": {
+        "type": "object",
+        "properties": {
+          "Help": {
+            "type": "string"
+          },
+          "Value": {
+            "type": "string"
+          },
+          "Provider": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": true
+      },
+      "ConfigProviderOptionType": {
+        "type": "string",
+        "enum": [
+          "Bits",
+          "bool",
+          "CommaSepList",
+          "Duration",
+          "Encoding",
+          "int",
+          "mtime|atime|btime|ctime",
+          "SizeSuffix",
+          "SpaceSepList",
+          "string",
+          "stringArray",
+          "Time",
+          "Tristate"
+        ]
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rclone-openapi",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": [
     "rclone",
     "openapi",
@@ -31,10 +31,12 @@
   ],
   "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:types": "openapi-typescript openapi.yaml -o types.d.ts",
+    "gen": "npm run gen:json && npm run gen:types"
   },
   "devDependencies": {
     "@redocly/cli": "^1.34.5",
-    "openapi-typescript": "^7.10.1"
+    "openapi-typescript": "^7.10.1",
+    "yaml": "^2.8.1"
   }
 }

package/types.d.ts

@@ -4012,6 +4012,79 @@ export interface components {
                 [key: string]: unknown;
             } | null;
         };
+        ConfigProvider: {
+            Aliases?: string[] | null;
+            CommandHelp?: components["schemas"]["ConfigProviderCommandHelp"][] | null;
+            Description?: string;
+            Hide?: boolean;
+            MetadataInfo?: components["schemas"]["ConfigProviderMetadataInfo"] | null;
+            Name?: string;
+            Options?: components["schemas"]["ConfigProviderOption"][];
+            Prefix?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        ConfigProviderCommandHelp: {
+            Long?: string;
+            Name?: string;
+            Opts?: {
+                [key: string]: unknown;
+            } | null;
+            Short?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        ConfigProviderMetadataInfo: {
+            Help?: string;
+            System?: {
+                [key: string]: components["schemas"]["ConfigProviderMetadataSystemEntry"];
+            } | null;
+        } & {
+            [key: string]: unknown;
+        };
+        ConfigProviderMetadataSystemEntry: {
+            Example?: string;
+            Help?: string;
+            ReadOnly?: boolean;
+            Type?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        ConfigProviderOption: {
+            Advanced?: boolean;
+            Default?: string[] | boolean | number | string | components["schemas"]["ConfigProviderOptionDefaultObject"] | null;
+            DefaultStr?: string;
+            Exclusive?: boolean;
+            FieldName?: string;
+            Help?: string;
+            Hide?: number;
+            IsPassword?: boolean;
+            Name?: string;
+            NoPrefix?: boolean;
+            Required?: boolean;
+            Sensitive?: boolean;
+            Type?: components["schemas"]["ConfigProviderOptionType"];
+            Value?: null;
+            ValueStr?: string;
+            Examples?: components["schemas"]["ConfigProviderOptionExample"][];
+            ShortOpt?: string;
+            Provider?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        ConfigProviderOptionDefaultObject: {
+            Valid?: boolean;
+            Value?: boolean;
+        };
+        ConfigProviderOptionExample: {
+            Help?: string;
+            Value?: string;
+            Provider?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        /** @enum {string} */
+        ConfigProviderOptionType: "Bits" | "bool" | "CommaSepList" | "Duration" | "Encoding" | "int" | "mtime|atime|btime|ctime" | "SizeSuffix" | "SpaceSepList" | "string" | "stringArray" | "Time" | "Tristate";
     };
     responses: {
         /** @description Any error response (HTTP 4xx/5xx) */
@@ -4296,7 +4369,10 @@ export interface components {
             };
             content: {
                 "application/json": {
-                    [key: string]: string;
+                    type: string;
+                    provider?: string;
+                } & {
+                    [key: string]: unknown;
                 };
             };
         };
@@ -4331,9 +4407,9 @@ export interface components {
             };
             content: {
                 "application/json": {
-                    providers: {
-                        [key: string]: unknown;
-                    }[];
+                    providers?: components["schemas"]["ConfigProvider"][];
+                } & {
+                    [key: string]: unknown;
                 };
             };
         };
@@ -4586,9 +4662,53 @@ export interface components {
             };
             content: {
                 "application/json": {
-                    [key: string]: {
+                    dlna: {
+                        [key: string]: unknown;
+                    };
+                    filter: {
+                        [key: string]: unknown;
+                    };
+                    ftp: {
+                        [key: string]: unknown;
+                    };
+                    http: {
+                        [key: string]: unknown;
+                    };
+                    log: {
+                        [key: string]: unknown;
+                    };
+                    main: {
                         [key: string]: unknown;
                     };
+                    mount: {
+                        [key: string]: unknown;
+                    };
+                    nfs: {
+                        [key: string]: unknown;
+                    };
+                    proxy: {
+                        [key: string]: unknown;
+                    };
+                    rc: {
+                        [key: string]: unknown;
+                    };
+                    restic: {
+                        [key: string]: unknown;
+                    };
+                    s3: {
+                        [key: string]: unknown;
+                    };
+                    sftp: {
+                        [key: string]: unknown;
+                    };
+                    vfs: {
+                        [key: string]: unknown;
+                    };
+                    webdav: {
+                        [key: string]: unknown;
+                    };
+                } & {
+                    [key: string]: unknown;
                 };
             };
         };
@@ -4769,6 +4889,15 @@ export interface components {
                         addr?: string;
                         /** @description Serve configuration parameters supplied at startup. */
                         params?: {
+                            fs: string;
+                            type: string;
+                            opt?: {
+                                [key: string]: unknown;
+                            };
+                            vfsOpt?: {
+                                [key: string]: unknown;
+                            };
+                        } & {
                             [key: string]: unknown;
                         };
                     }[];