rclone-openapi 1.0.6 → 1.0.8

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 +44 -7
  2. package/package.json +1 -1
  3. package/types.d.ts +11 -7
package/openapi.json CHANGED
@@ -2510,7 +2510,7 @@
2510
2510
  "/options/set": {
2511
2511
  "post": {
2512
2512
  "summary": "Set option values",
2513
- "description": "Sets temporary option overrides for the running process by supplying key/value pairs.",
2513
+ "description": "Sets temporary option overrides for the running process by supplying key/value pairs grouped under option block names. Provide one or more query parameters whose names match the blocks you want to modify (for example `main`, `rc`, `http`). Each block parameter carries an object of option overrides.\n",
2514
2514
  "tags": [],
2515
2515
  "parameters": [
2516
2516
  {
@@ -4445,14 +4445,47 @@
4445
4445
  }
4446
4446
  },
4447
4447
  "Options_SetPostAdditionalParam": {
4448
- "name": "params",
4448
+ "name": "block",
4449
4449
  "in": "query",
4450
- "description": "Additional arbitrary parameters allowed.",
4450
+ "description": "Placeholder parameter representing any option block override. Replace `block` with the actual block name you wish to modify (for example `main`, `rc`, `http`, `s3`, `mount`). Supply one such query parameter per block. Encode the overrides for that block using deep-object syntax so each option name becomes a nested key. Example: `?main[HTTPProxy]=http://proxy.example&rc[NoAuth]=true`.\n",
4451
+ "style": "deepObject",
4452
+ "explode": true,
4451
4453
  "schema": {
4452
- "type": "object"
4454
+ "type": "object",
4455
+ "additionalProperties": {
4456
+ "oneOf": [
4457
+ {
4458
+ "type": "string"
4459
+ },
4460
+ {
4461
+ "type": "number"
4462
+ },
4463
+ {
4464
+ "type": "integer"
4465
+ },
4466
+ {
4467
+ "type": "boolean"
4468
+ },
4469
+ {
4470
+ "type": "array",
4471
+ "items": {}
4472
+ },
4473
+ {
4474
+ "type": "object",
4475
+ "additionalProperties": {}
4476
+ }
4477
+ ]
4478
+ }
4453
4479
  },
4454
- "style": "form",
4455
- "explode": true
4480
+ "examples": {
4481
+ "setProxy": {
4482
+ "summary": "Set HTTP proxy and disable RC auth",
4483
+ "value": {
4484
+ "HTTPProxy": "http://proxy.example",
4485
+ "NoAuth": true
4486
+ }
4487
+ }
4488
+ }
4456
4489
  },
4457
4490
  "Serve_StartPostTypeParam": {
4458
4491
  "name": "type",
@@ -6615,7 +6648,11 @@
6615
6648
  "description": "Serve configuration parameters supplied at startup."
6616
6649
  }
6617
6650
  },
6618
- "additionalProperties": false
6651
+ "additionalProperties": false,
6652
+ "required": [
6653
+ "id",
6654
+ "addr"
6655
+ ]
6619
6656
  }
6620
6657
  }
6621
6658
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rclone-openapi",
3
- "version": "1.0.6",
3
+ "version": "1.0.8",
4
4
  "keywords": [
5
5
  "rclone",
6
6
  "openapi",
package/types.d.ts CHANGED
@@ -3218,13 +3218,13 @@ export interface paths {
3218
3218
  put?: never;
3219
3219
  /**
3220
3220
  * Set option values
3221
- * @description Sets temporary option overrides for the running process by supplying key/value pairs.
3221
+ * @description Sets temporary option overrides for the running process by supplying key/value pairs grouped under option block names. Provide one or more query parameters whose names match the blocks you want to modify (for example `main`, `rc`, `http`). Each block parameter carries an object of option overrides.
3222
3222
  */
3223
3223
  post: {
3224
3224
  parameters: {
3225
3225
  query?: {
3226
- /** @description Additional arbitrary parameters allowed. */
3227
- params?: components["parameters"]["Options_SetPostAdditionalParam"];
3226
+ /** @description Placeholder parameter representing any option block override. Replace `block` with the actual block name you wish to modify (for example `main`, `rc`, `http`, `s3`, `mount`). Supply one such query parameter per block. Encode the overrides for that block using deep-object syntax so each option name becomes a nested key. Example: `?main[HTTPProxy]=http://proxy.example&rc[NoAuth]=true`. */
3227
+ block?: components["parameters"]["Options_SetPostAdditionalParam"];
3228
3228
  /** @description Assign the request to a custom stats group. */
3229
3229
  _group?: components["parameters"]["GlobalGroupParam"];
3230
3230
  /** @description Run the command asynchronously. Returns a job id immediately. */
@@ -4955,9 +4955,9 @@ export interface components {
4955
4955
  "application/json": {
4956
4956
  list: {
4957
4957
  /** @description Identifier returned by `serve/start`. */
4958
- id?: string;
4958
+ id: string;
4959
4959
  /** @description Address and port the server is listening on. */
4960
- addr?: string;
4960
+ addr: string;
4961
4961
  /** @description Serve configuration parameters supplied at startup. */
4962
4962
  params?: {
4963
4963
  fs: string;
@@ -5443,8 +5443,12 @@ export interface components {
5443
5443
  Options_GetPostBlocksParam: string;
5444
5444
  /** @description Optional comma-separated list of option block names to describe. */
5445
5445
  Options_InfoPostBlocksParam: string;
5446
- /** @description Additional arbitrary parameters allowed. */
5447
- Options_SetPostAdditionalParam: Record<string, never>;
5446
+ /** @description Placeholder parameter representing any option block override. Replace `block` with the actual block name you wish to modify (for example `main`, `rc`, `http`, `s3`, `mount`). Supply one such query parameter per block. Encode the overrides for that block using deep-object syntax so each option name becomes a nested key. Example: `?main[HTTPProxy]=http://proxy.example&rc[NoAuth]=true`. */
5447
+ Options_SetPostAdditionalParam: {
5448
+ [key: string]: string | number | boolean | unknown[] | {
5449
+ [key: string]: unknown;
5450
+ };
5451
+ };
5448
5452
  /** @description Type of server to start (e.g. `http`, `webdav`, `ftp`, `sftp`). */
5449
5453
  Serve_StartPostTypeParam: string;
5450
5454
  /** @description Remote path that will be served. */