rclone-openapi 1.0.5 → 1.0.6

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.
Files changed (3) hide show
  1. package/openapi.json +122 -1
  2. package/package.json +1 -1
  3. package/types.d.ts +46 -5
package/openapi.json CHANGED
@@ -1888,6 +1888,36 @@
1888
1888
  {
1889
1889
  "$ref": "#/components/parameters/Operations_ListPostOptParam"
1890
1890
  },
1891
+ {
1892
+ "$ref": "#/components/parameters/Operations_ListPostRecurseParam"
1893
+ },
1894
+ {
1895
+ "$ref": "#/components/parameters/Operations_ListPostNoModTimeParam"
1896
+ },
1897
+ {
1898
+ "$ref": "#/components/parameters/Operations_ListPostShowEncryptedParam"
1899
+ },
1900
+ {
1901
+ "$ref": "#/components/parameters/Operations_ListPostShowOrigIDsParam"
1902
+ },
1903
+ {
1904
+ "$ref": "#/components/parameters/Operations_ListPostShowHashParam"
1905
+ },
1906
+ {
1907
+ "$ref": "#/components/parameters/Operations_ListPostNoMimeTypeParam"
1908
+ },
1909
+ {
1910
+ "$ref": "#/components/parameters/Operations_ListPostDirsOnlyParam"
1911
+ },
1912
+ {
1913
+ "$ref": "#/components/parameters/Operations_ListPostFilesOnlyParam"
1914
+ },
1915
+ {
1916
+ "$ref": "#/components/parameters/Operations_ListPostMetadataParam"
1917
+ },
1918
+ {
1919
+ "$ref": "#/components/parameters/Operations_ListPostHashTypesParam"
1920
+ },
1891
1921
  {
1892
1922
  "$ref": "#/components/parameters/GlobalGroupParam"
1893
1923
  },
@@ -3866,7 +3896,92 @@
3866
3896
  "schema": {
3867
3897
  "type": "string"
3868
3898
  },
3869
- "description": "Optional JSON object of listing flags (e.g. `{ \"recurse\": true, \"showHash\": true }`)."
3899
+ "description": "Optional JSON-encoded object of listing flags (e.g. `{ \"recurse\": true, \"showHash\": true }`)."
3900
+ },
3901
+ "Operations_ListPostRecurseParam": {
3902
+ "name": "recurse",
3903
+ "in": "query",
3904
+ "description": "Set to true to list directories recursively.",
3905
+ "schema": {
3906
+ "type": "boolean"
3907
+ }
3908
+ },
3909
+ "Operations_ListPostNoModTimeParam": {
3910
+ "name": "noModTime",
3911
+ "in": "query",
3912
+ "description": "Set to true to omit modification times for faster listings on some backends.",
3913
+ "schema": {
3914
+ "type": "boolean"
3915
+ }
3916
+ },
3917
+ "Operations_ListPostShowEncryptedParam": {
3918
+ "name": "showEncrypted",
3919
+ "in": "query",
3920
+ "description": "Set to true to include encrypted names when using crypt remotes.",
3921
+ "schema": {
3922
+ "type": "boolean"
3923
+ }
3924
+ },
3925
+ "Operations_ListPostShowOrigIDsParam": {
3926
+ "name": "showOrigIDs",
3927
+ "in": "query",
3928
+ "description": "Set to true to include original backend identifiers where available.",
3929
+ "schema": {
3930
+ "type": "boolean"
3931
+ }
3932
+ },
3933
+ "Operations_ListPostShowHashParam": {
3934
+ "name": "showHash",
3935
+ "in": "query",
3936
+ "description": "Set to true to include hash digests for each entry.",
3937
+ "schema": {
3938
+ "type": "boolean"
3939
+ }
3940
+ },
3941
+ "Operations_ListPostNoMimeTypeParam": {
3942
+ "name": "noMimeType",
3943
+ "in": "query",
3944
+ "description": "Set to true to omit MIME type detection.",
3945
+ "schema": {
3946
+ "type": "boolean"
3947
+ }
3948
+ },
3949
+ "Operations_ListPostDirsOnlyParam": {
3950
+ "name": "dirsOnly",
3951
+ "in": "query",
3952
+ "description": "Set to true to return only directory entries.",
3953
+ "schema": {
3954
+ "type": "boolean"
3955
+ }
3956
+ },
3957
+ "Operations_ListPostFilesOnlyParam": {
3958
+ "name": "filesOnly",
3959
+ "in": "query",
3960
+ "description": "Set to true to return only file entries.",
3961
+ "schema": {
3962
+ "type": "boolean"
3963
+ }
3964
+ },
3965
+ "Operations_ListPostMetadataParam": {
3966
+ "name": "metadata",
3967
+ "in": "query",
3968
+ "description": "Set to true to include backend-provided metadata maps.",
3969
+ "schema": {
3970
+ "type": "boolean"
3971
+ }
3972
+ },
3973
+ "Operations_ListPostHashTypesParam": {
3974
+ "name": "hashTypes",
3975
+ "in": "query",
3976
+ "description": "Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`).",
3977
+ "schema": {
3978
+ "type": "array",
3979
+ "items": {
3980
+ "type": "string"
3981
+ }
3982
+ },
3983
+ "style": "form",
3984
+ "explode": true
3870
3985
  },
3871
3986
  "Operations_StatPostFsParam": {
3872
3987
  "name": "fs",
@@ -5547,8 +5662,14 @@
5547
5662
  "properties": {
5548
5663
  "list": {
5549
5664
  "type": "array",
5665
+ "description": "Array of entries equivalent to the items returned by `rclone lsjson`.",
5550
5666
  "items": {
5551
5667
  "type": "object",
5668
+ "required": [
5669
+ "Path",
5670
+ "Name",
5671
+ "IsDir"
5672
+ ],
5552
5673
  "properties": {
5553
5674
  "Path": {
5554
5675
  "type": "string",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rclone-openapi",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "keywords": [
5
5
  "rclone",
6
6
  "openapi",
package/types.d.ts CHANGED
@@ -2496,8 +2496,28 @@ export interface paths {
2496
2496
  fs: components["parameters"]["Operations_ListPostFsParam"];
2497
2497
  /** @description Directory path within `fs` to list; leave empty to target the root. */
2498
2498
  remote: components["parameters"]["Operations_ListPostRemoteParam"];
2499
- /** @description Optional JSON object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
2499
+ /** @description Optional JSON-encoded object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
2500
2500
  opt?: components["parameters"]["Operations_ListPostOptParam"];
2501
+ /** @description Set to true to list directories recursively. */
2502
+ recurse?: components["parameters"]["Operations_ListPostRecurseParam"];
2503
+ /** @description Set to true to omit modification times for faster listings on some backends. */
2504
+ noModTime?: components["parameters"]["Operations_ListPostNoModTimeParam"];
2505
+ /** @description Set to true to include encrypted names when using crypt remotes. */
2506
+ showEncrypted?: components["parameters"]["Operations_ListPostShowEncryptedParam"];
2507
+ /** @description Set to true to include original backend identifiers where available. */
2508
+ showOrigIDs?: components["parameters"]["Operations_ListPostShowOrigIDsParam"];
2509
+ /** @description Set to true to include hash digests for each entry. */
2510
+ showHash?: components["parameters"]["Operations_ListPostShowHashParam"];
2511
+ /** @description Set to true to omit MIME type detection. */
2512
+ noMimeType?: components["parameters"]["Operations_ListPostNoMimeTypeParam"];
2513
+ /** @description Set to true to return only directory entries. */
2514
+ dirsOnly?: components["parameters"]["Operations_ListPostDirsOnlyParam"];
2515
+ /** @description Set to true to return only file entries. */
2516
+ filesOnly?: components["parameters"]["Operations_ListPostFilesOnlyParam"];
2517
+ /** @description Set to true to include backend-provided metadata maps. */
2518
+ metadata?: components["parameters"]["Operations_ListPostMetadataParam"];
2519
+ /** @description Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`). */
2520
+ hashTypes?: components["parameters"]["Operations_ListPostHashTypesParam"];
2501
2521
  /** @description Assign the request to a custom stats group. */
2502
2522
  _group?: components["parameters"]["GlobalGroupParam"];
2503
2523
  /** @description Run the command asynchronously. Returns a job id immediately. */
@@ -4615,11 +4635,12 @@ export interface components {
4615
4635
  };
4616
4636
  content: {
4617
4637
  "application/json": {
4638
+ /** @description Array of entries equivalent to the items returned by `rclone lsjson`. */
4618
4639
  list: {
4619
4640
  /** @description Path relative to the requested remote root. */
4620
- Path?: string;
4641
+ Path: string;
4621
4642
  /** @description Base name of the entry. */
4622
- Name?: string;
4643
+ Name: string;
4623
4644
  /** @description Object size in bytes. */
4624
4645
  Size?: number;
4625
4646
  /** @description MIME type where available. */
@@ -4627,7 +4648,7 @@ export interface components {
4627
4648
  /** @description Modification timestamp in RFC3339 format. */
4628
4649
  ModTime?: string;
4629
4650
  /** @description True if the entry represents a directory. */
4630
- IsDir?: boolean;
4651
+ IsDir: boolean;
4631
4652
  /** @description Hash digests keyed by algorithm when requested. */
4632
4653
  Hashes?: {
4633
4654
  [key: string]: string;
@@ -5290,8 +5311,28 @@ export interface components {
5290
5311
  Operations_ListPostFsParam: string;
5291
5312
  /** @description Directory path within `fs` to list; leave empty to target the root. */
5292
5313
  Operations_ListPostRemoteParam: string;
5293
- /** @description Optional JSON object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
5314
+ /** @description Optional JSON-encoded object of listing flags (e.g. `{ "recurse": true, "showHash": true }`). */
5294
5315
  Operations_ListPostOptParam: string;
5316
+ /** @description Set to true to list directories recursively. */
5317
+ Operations_ListPostRecurseParam: boolean;
5318
+ /** @description Set to true to omit modification times for faster listings on some backends. */
5319
+ Operations_ListPostNoModTimeParam: boolean;
5320
+ /** @description Set to true to include encrypted names when using crypt remotes. */
5321
+ Operations_ListPostShowEncryptedParam: boolean;
5322
+ /** @description Set to true to include original backend identifiers where available. */
5323
+ Operations_ListPostShowOrigIDsParam: boolean;
5324
+ /** @description Set to true to include hash digests for each entry. */
5325
+ Operations_ListPostShowHashParam: boolean;
5326
+ /** @description Set to true to omit MIME type detection. */
5327
+ Operations_ListPostNoMimeTypeParam: boolean;
5328
+ /** @description Set to true to return only directory entries. */
5329
+ Operations_ListPostDirsOnlyParam: boolean;
5330
+ /** @description Set to true to return only file entries. */
5331
+ Operations_ListPostFilesOnlyParam: boolean;
5332
+ /** @description Set to true to include backend-provided metadata maps. */
5333
+ Operations_ListPostMetadataParam: boolean;
5334
+ /** @description Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`). */
5335
+ Operations_ListPostHashTypesParam: string[];
5295
5336
  /** @description Remote name or path that contains the item to inspect. */
5296
5337
  Operations_StatPostFsParam: string;
5297
5338
  /** @description Path to the file or directory within `fs` to describe. */