From bcc0a9c9a41fa579fddcfe3aa735d1a73d7d852c Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:41:17 +0100 Subject: [PATCH] move extensions-sdk api content to reference (#20694) * move extensions-sdk api content to reference * review suggestion * rename file --- .../extensions-sdk/dev/api/backend.md | 6 +-- .../dev/api/dashboard-routes-navigation.md | 2 +- .../extensions-sdk/dev/api/dashboard.md | 6 +-- .../extensions-sdk/dev/api/docker.md | 6 +-- .../extensions-sdk/dev/api/overview.md | 2 +- .../dev/api/reference/README.md | 40 -------------- .../api/extensions-sdk}/BackendV0.md | 1 + .../api/extensions-sdk}/DesktopUI.md | 1 + .../api/extensions-sdk}/Dialog.md | 1 + .../api/extensions-sdk}/Docker.md | 1 + .../api/extensions-sdk}/DockerCommand.md | 1 + .../extensions-sdk}/DockerDesktopClient.md | 1 + .../api/extensions-sdk}/Exec.md | 1 + .../api/extensions-sdk}/ExecOptions.md | 1 + .../api/extensions-sdk}/ExecProcess.md | 1 + .../api/extensions-sdk}/ExecResult.md | 1 + .../api/extensions-sdk}/ExecResultV0.md | 1 + .../api/extensions-sdk}/ExecStreamOptions.md | 1 + .../api/extensions-sdk}/Extension.md | 1 + .../api/extensions-sdk}/ExtensionCli.md | 1 + .../api/extensions-sdk}/ExtensionHost.md | 1 + .../api/extensions-sdk}/ExtensionVM.md | 1 + .../api/extensions-sdk}/Host.md | 1 + .../api/extensions-sdk}/HttpService.md | 1 + .../api/extensions-sdk}/NavigationIntents.md | 1 + .../api/extensions-sdk}/OpenDialogResult.md | 1 + .../api/extensions-sdk}/RawExecResult.md | 1 + .../api/extensions-sdk}/RequestConfig.md | 1 + .../api/extensions-sdk}/RequestConfigV0.md | 1 + .../api/extensions-sdk}/ServiceError.md | 1 + .../api/extensions-sdk}/SpawnOptions.md | 1 + .../api/extensions-sdk}/Toast.md | 1 + .../reference/api/extensions-sdk/_index.md | 41 ++++++++++++++ data/toc.yaml | 54 +++++++++---------- 34 files changed, 105 insertions(+), 78 deletions(-) delete mode 100644 content/extensions/extensions-sdk/dev/api/reference/README.md rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/BackendV0.md (98%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/DesktopUI.md (86%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/Dialog.md (92%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/Docker.md (97%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/DockerCommand.md (79%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/DockerDesktopClient.md (99%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/Exec.md (95%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExecOptions.md (85%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExecProcess.md (82%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExecResult.md (95%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExecResultV0.md (93%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExecStreamOptions.md (96%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/Extension.md (87%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExtensionCli.md (79%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExtensionHost.md (95%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ExtensionVM.md (96%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/Host.md (94%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/HttpService.md (97%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/NavigationIntents.md (98%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/OpenDialogResult.md (90%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/RawExecResult.md (90%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/RequestConfig.md (86%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/RequestConfigV0.md (85%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/ServiceError.md (86%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/SpawnOptions.md (89%) rename content/{extensions/extensions-sdk/dev/api/reference/interfaces => reference/api/extensions-sdk}/Toast.md (95%) create mode 100644 content/reference/api/extensions-sdk/_index.md diff --git a/content/extensions/extensions-sdk/dev/api/backend.md b/content/extensions/extensions-sdk/dev/api/backend.md index df8ab51c63..56825ca7ca 100644 --- a/content/extensions/extensions-sdk/dev/api/backend.md +++ b/content/extensions/extensions-sdk/dev/api/backend.md @@ -20,7 +20,7 @@ ddClient.extension.vm.service .then((value: any) => console.log(value) ``` -See [Service API Reference](reference/interfaces/HttpService.md) for other methods such as POST, UPDATE, and DELETE. +See [Service API Reference](/reference/api/extensions-sdk/HttpService.md) for other methods such as POST, UPDATE, and DELETE. > Deprecated extension backend communication > @@ -92,7 +92,7 @@ await ddClient.extension.vm.cli.exec("ls", ["-l"], { }); ``` -For more details, refer to the [Extension VM API Reference](reference/interfaces/ExtensionVM.md) +For more details, refer to the [Extension VM API Reference](/reference/api/extensions-sdk/ExtensionVM.md) > Deprecated extension backend command execution > @@ -143,7 +143,7 @@ await ddClient.extension.host.cli.exec("kubectl", ["-h"], { You can stream the output of the command executed in the backend container or in the host. -For more details, refer to the [Extension Host API Reference](reference/interfaces/ExtensionHost.md) +For more details, refer to the [Extension Host API Reference](/reference/api/extensions-sdk/ExtensionHost.md) > Deprecated invocation of extension binary > diff --git a/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md b/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md index a9db1122ac..1d227449b5 100644 --- a/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md +++ b/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md @@ -34,7 +34,7 @@ try { A promise that fails if the container doesn't exist. -For more details about all navigation methods, see the [Navigation API reference](reference/interfaces/NavigationIntents.md). +For more details about all navigation methods, see the [Navigation API reference](/reference/api/extensions-sdk/NavigationIntents.md). > Deprecated navigation methods > diff --git a/content/extensions/extensions-sdk/dev/api/dashboard.md b/content/extensions/extensions-sdk/dev/api/dashboard.md index 1b5bc34dfd..f9d626b945 100644 --- a/content/extensions/extensions-sdk/dev/api/dashboard.md +++ b/content/extensions/extensions-sdk/dev/api/dashboard.md @@ -41,7 +41,7 @@ Use to display a toast message of type error. ddClient.desktopUI.toast.error("message"); ``` -For more details about method parameters and the return types available, see [Toast API reference](reference/interfaces/Toast.md). +For more details about method parameters and the return types available, see [Toast API reference](/reference/api/extensions-sdk/Toast.md). > Deprecated user notifications > @@ -57,7 +57,7 @@ window.ddClient.toastError("message"); This function opens a file selector dialog that asks the user to select a file or folder. -▸ **showOpenDialog**(`dialogProperties`): `Promise`<[`OpenDialogResult`](reference/interfaces/OpenDialogResult.md)\>: +▸ **showOpenDialog**(`dialogProperties`): `Promise`<[`OpenDialogResult`](/reference/api/extensions-sdk/OpenDialogResult.md)\>: The `dialogProperties` parameter is a list of flags passed to Electron to customize the dialog's behaviour. For example, you can pass `multiSelections` to allow a user to select multiple files. See [Electron's documentation](https://www.electronjs.org/docs/latest/api/dialog) for a full list. @@ -82,7 +82,7 @@ ddClient.host.openExternal("https://docker.com"); > The URL must have the protocol `http` or `https`. -For more details about method parameters and the return types available, see [Desktop host API reference](reference/interfaces/Host.md). +For more details about method parameters and the return types available, see [Desktop host API reference](/reference/api/extensions-sdk/Host.md). > Deprecated user notifications > diff --git a/content/extensions/extensions-sdk/dev/api/docker.md b/content/extensions/extensions-sdk/dev/api/docker.md index 11c1129cb3..244e2a68ff 100644 --- a/content/extensions/extensions-sdk/dev/api/docker.md +++ b/content/extensions/extensions-sdk/dev/api/docker.md @@ -24,7 +24,7 @@ To get the list of local container images: const images = await ddClient.docker.listImages(); ``` -See the [Docker API reference](reference/interfaces/Docker.md) for details about these methods. +See the [Docker API reference](/reference/api/extensions-sdk/Docker.md) for details about these methods. > Deprecated access to Docker objects > @@ -40,7 +40,7 @@ const images = await window.ddClient.listImages(); Extensions can also directly execute the `docker` command line. -▸ **exec**(`cmd`, `args`): `Promise`<[`ExecResult`](reference/interfaces/ExecResult.md)\> +▸ **exec**(`cmd`, `args`): `Promise`<[`ExecResult`](/reference/api/extensions-sdk/ExecResult.md)\> ```typescript const result = await ddClient.docker.cli.exec("info", [ @@ -136,7 +136,7 @@ await ddClient.docker.cli.exec( > > You need to invoke `exec()` for each command and parse results to pass parameters to the next command if needed. -See the [Exec API reference](reference/interfaces/Exec.md) for details about these methods. +See the [Exec API reference](/reference/api/extensions-sdk/Exec.md) for details about these methods. > Deprecated execution of Docker commands > diff --git a/content/extensions/extensions-sdk/dev/api/overview.md b/content/extensions/extensions-sdk/dev/api/overview.md index 394bc016d0..730a786192 100644 --- a/content/extensions/extensions-sdk/dev/api/overview.md +++ b/content/extensions/extensions-sdk/dev/api/overview.md @@ -34,4 +34,4 @@ The `ddClient` object gives access to various APIs: - [Dashboard](dashboard.md) - [Navigation](dashboard-routes-navigation.md) -Find the Extensions API reference [here](reference/README.md). +Find the Extensions API reference [here](reference/api/extensions-sdk/_index.md). diff --git a/content/extensions/extensions-sdk/dev/api/reference/README.md b/content/extensions/extensions-sdk/dev/api/reference/README.md deleted file mode 100644 index 645ad2959c..0000000000 --- a/content/extensions/extensions-sdk/dev/api/reference/README.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: Docker extension API reference -keywords: Docker, extensions, sdk, API, reference -aliases: - - /desktop/extensions-sdk/dev/api/reference/README/ ---- - -# Extensions API Reference - -## Dashboard Interfaces - -- [Host](interfaces/Host.md) -- [NavigationIntents](interfaces/NavigationIntents.md) -- [Toast](interfaces/Toast.md) - -## Other Interfaces - -- [ExecResultV0](interfaces/ExecResultV0.md) -- [RequestConfigV0](interfaces/RequestConfigV0.md) -- [BackendV0](interfaces/BackendV0.md) -- [OpenDialogResult](interfaces/OpenDialogResult.md) -- [Dialog](interfaces/Dialog.md) -- [Docker](interfaces/Docker.md) -- [DockerCommand](interfaces/DockerCommand.md) -- [ExecOptions](interfaces/ExecOptions.md) -- [SpawnOptions](interfaces/SpawnOptions.md) -- [Exec](interfaces/Exec.md) -- [ExecProcess](interfaces/ExecProcess.md) -- [ExecStreamOptions](interfaces/ExecStreamOptions.md) -- [ExecResult](interfaces/ExecResult.md) -- [RawExecResult](interfaces/RawExecResult.md) -- [Extension](interfaces/Extension.md) -- [DesktopUI](interfaces/DesktopUI.md) -- [ExtensionVM](interfaces/ExtensionVM.md) -- [ExtensionHost](interfaces/ExtensionHost.md) -- [ExtensionCli](interfaces/ExtensionCli.md) -- [HttpService](interfaces/HttpService.md) -- [RequestConfig](interfaces/RequestConfig.md) -- [ServiceError](interfaces/ServiceError.md) -- [DockerDesktopClient](interfaces/DockerDesktopClient.md) diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md b/content/reference/api/extensions-sdk/BackendV0.md similarity index 98% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md rename to content/reference/api/extensions-sdk/BackendV0.md index cb61c8a757..a0a8fd38a3 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md +++ b/content/reference/api/extensions-sdk/BackendV0.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0/ --- # Interface: BackendV0 diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md b/content/reference/api/extensions-sdk/DesktopUI.md similarity index 86% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md rename to content/reference/api/extensions-sdk/DesktopUI.md index e159dbed6b..efe67c0249 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md +++ b/content/reference/api/extensions-sdk/DesktopUI.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ --- # Interface: DesktopUI diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md b/content/reference/api/extensions-sdk/Dialog.md similarity index 92% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md rename to content/reference/api/extensions-sdk/Dialog.md index 2d0a2c52ba..c575e228d8 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md +++ b/content/reference/api/extensions-sdk/Dialog.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/Dialog/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/Dialog/ --- # Interface: Dialog diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md b/content/reference/api/extensions-sdk/Docker.md similarity index 97% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md rename to content/reference/api/extensions-sdk/Docker.md index 5945c8bf35..0c35c05276 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md +++ b/content/reference/api/extensions-sdk/Docker.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/Docker/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/Docker/ --- # Interface: Docker diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md b/content/reference/api/extensions-sdk/DockerCommand.md similarity index 79% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md rename to content/reference/api/extensions-sdk/DockerCommand.md index 1f1cc891f8..94c2f870eb 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md +++ b/content/reference/api/extensions-sdk/DockerCommand.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand/ --- # Interface: DockerCommand diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md b/content/reference/api/extensions-sdk/DockerDesktopClient.md similarity index 99% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md rename to content/reference/api/extensions-sdk/DockerDesktopClient.md index 1189dc346d..f25586cf1a 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md +++ b/content/reference/api/extensions-sdk/DockerDesktopClient.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/ --- # Interface: DockerDesktopClient diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Exec.md b/content/reference/api/extensions-sdk/Exec.md similarity index 95% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/Exec.md rename to content/reference/api/extensions-sdk/Exec.md index 0799bee707..dbb5ce3b11 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Exec.md +++ b/content/reference/api/extensions-sdk/Exec.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/Exec/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/Exec/ --- # Interface: Exec diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md b/content/reference/api/extensions-sdk/ExecOptions.md similarity index 85% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md rename to content/reference/api/extensions-sdk/ExecOptions.md index a5f98b770e..8b56710e62 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md +++ b/content/reference/api/extensions-sdk/ExecOptions.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecOptions/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions/ --- # Interface: ExecOptions diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md b/content/reference/api/extensions-sdk/ExecProcess.md similarity index 82% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md rename to content/reference/api/extensions-sdk/ExecProcess.md index d1e1b83df0..8bbbbe7db5 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md +++ b/content/reference/api/extensions-sdk/ExecProcess.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess/ --- # Interface: ExecProcess diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult.md b/content/reference/api/extensions-sdk/ExecResult.md similarity index 95% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult.md rename to content/reference/api/extensions-sdk/ExecResult.md index c22fa344c8..1a21264da9 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult.md +++ b/content/reference/api/extensions-sdk/ExecResult.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult/ --- # Interface: ExecResult diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md b/content/reference/api/extensions-sdk/ExecResultV0.md similarity index 93% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md rename to content/reference/api/extensions-sdk/ExecResultV0.md index 926b3639d6..d9efb9f0ad 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md +++ b/content/reference/api/extensions-sdk/ExecResultV0.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/ --- # Interface: ExecResultV0 diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md b/content/reference/api/extensions-sdk/ExecStreamOptions.md similarity index 96% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md rename to content/reference/api/extensions-sdk/ExecStreamOptions.md index b70d94c5d2..48228dddcb 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md +++ b/content/reference/api/extensions-sdk/ExecStreamOptions.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/ --- # Interface: ExecStreamOptions diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Extension.md b/content/reference/api/extensions-sdk/Extension.md similarity index 87% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/Extension.md rename to content/reference/api/extensions-sdk/Extension.md index 99ebf2ed84..658e7eba16 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Extension.md +++ b/content/reference/api/extensions-sdk/Extension.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/Extension/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/Extension/ --- # Interface: Extension diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md b/content/reference/api/extensions-sdk/ExtensionCli.md similarity index 79% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md rename to content/reference/api/extensions-sdk/ExtensionCli.md index 3ced8fccaf..799af60531 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md +++ b/content/reference/api/extensions-sdk/ExtensionCli.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/ --- # Interface: ExtensionCli diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md b/content/reference/api/extensions-sdk/ExtensionHost.md similarity index 95% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md rename to content/reference/api/extensions-sdk/ExtensionHost.md index 5074c8e5c8..d6db5b8b45 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md +++ b/content/reference/api/extensions-sdk/ExtensionHost.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/ --- # Interface: ExtensionHost diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md b/content/reference/api/extensions-sdk/ExtensionVM.md similarity index 96% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md rename to content/reference/api/extensions-sdk/ExtensionVM.md index d75e056ca8..54b43dc985 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md +++ b/content/reference/api/extensions-sdk/ExtensionVM.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/ --- # Interface: ExtensionVM diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Host.md b/content/reference/api/extensions-sdk/Host.md similarity index 94% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/Host.md rename to content/reference/api/extensions-sdk/Host.md index 2895149d39..10301c9574 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Host.md +++ b/content/reference/api/extensions-sdk/Host.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/Host/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/Host/ --- # Interface: Host diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/HttpService.md b/content/reference/api/extensions-sdk/HttpService.md similarity index 97% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/HttpService.md rename to content/reference/api/extensions-sdk/HttpService.md index b9a9f60fdd..a133c64f75 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/HttpService.md +++ b/content/reference/api/extensions-sdk/HttpService.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/HttpService/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/HttpService/ --- # Interface: HttpService diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md b/content/reference/api/extensions-sdk/NavigationIntents.md similarity index 98% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md rename to content/reference/api/extensions-sdk/NavigationIntents.md index 538f109f28..9975d9a6fb 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md +++ b/content/reference/api/extensions-sdk/NavigationIntents.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/ --- # Interface: NavigationIntents diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md b/content/reference/api/extensions-sdk/OpenDialogResult.md similarity index 90% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md rename to content/reference/api/extensions-sdk/OpenDialogResult.md index 8e27ee6d98..3009555444 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md +++ b/content/reference/api/extensions-sdk/OpenDialogResult.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/ --- # Interface: OpenDialogResult diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md b/content/reference/api/extensions-sdk/RawExecResult.md similarity index 90% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md rename to content/reference/api/extensions-sdk/RawExecResult.md index 4bca29e1c4..3d5b53a6ae 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md +++ b/content/reference/api/extensions-sdk/RawExecResult.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult/ --- # Interface: RawExecResult diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md b/content/reference/api/extensions-sdk/RequestConfig.md similarity index 86% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md rename to content/reference/api/extensions-sdk/RequestConfig.md index c1d7bca7e4..6e16901398 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md +++ b/content/reference/api/extensions-sdk/RequestConfig.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig/ --- # Interface: RequestConfig diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md b/content/reference/api/extensions-sdk/RequestConfigV0.md similarity index 85% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md rename to content/reference/api/extensions-sdk/RequestConfigV0.md index f8ad8a7ae0..7359325c6d 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md +++ b/content/reference/api/extensions-sdk/RequestConfigV0.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/ --- # Interface: RequestConfigV0 diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError.md b/content/reference/api/extensions-sdk/ServiceError.md similarity index 86% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError.md rename to content/reference/api/extensions-sdk/ServiceError.md index 22cc8b0fe4..7a9db33fd1 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError.md +++ b/content/reference/api/extensions-sdk/ServiceError.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/ServiceError/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError/ --- # Interface: ServiceError diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md b/content/reference/api/extensions-sdk/SpawnOptions.md similarity index 89% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md rename to content/reference/api/extensions-sdk/SpawnOptions.md index cac7973c6a..f97f559d5e 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md +++ b/content/reference/api/extensions-sdk/SpawnOptions.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/SpawnOptions/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions/ --- # Interface: SpawnOptions diff --git a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Toast.md b/content/reference/api/extensions-sdk/Toast.md similarity index 95% rename from content/extensions/extensions-sdk/dev/api/reference/interfaces/Toast.md rename to content/reference/api/extensions-sdk/Toast.md index a1a2fb6cf4..239690fefc 100644 --- a/content/extensions/extensions-sdk/dev/api/reference/interfaces/Toast.md +++ b/content/reference/api/extensions-sdk/Toast.md @@ -3,6 +3,7 @@ description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/Toast/ + - /extensions/extensions-sdk/dev/api/reference/interfaces/Toast/ --- # Interface: Toast diff --git a/content/reference/api/extensions-sdk/_index.md b/content/reference/api/extensions-sdk/_index.md new file mode 100644 index 0000000000..f3a4d0f0bb --- /dev/null +++ b/content/reference/api/extensions-sdk/_index.md @@ -0,0 +1,41 @@ +--- +description: Docker extension API reference +keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/README/ + - /extensions/extensions-sdk/dev/api/reference/README/ +--- + +# Extensions API Reference + +## Dashboard interfaces + +- [Host](Host.md) +- [NavigationIntents](NavigationIntents.md) +- [Toast](Toast.md) + +## Other interfaces + +- [ExecResultV0](ExecResultV0.md) +- [RequestConfigV0](RequestConfigV0.md) +- [BackendV0](BackendV0.md) +- [OpenDialogResult](OpenDialogResult.md) +- [Dialog](Dialog.md) +- [Docker](Docker.md) +- [DockerCommand](DockerCommand.md) +- [ExecOptions](ExecOptions.md) +- [SpawnOptions](SpawnOptions.md) +- [Exec](Exec.md) +- [ExecProcess](ExecProcess.md) +- [ExecStreamOptions](ExecStreamOptions.md) +- [ExecResult](ExecResult.md) +- [RawExecResult](RawExecResult.md) +- [Extension](Extension.md) +- [DesktopUI](DesktopUI.md) +- [ExtensionVM](ExtensionVM.md) +- [ExtensionHost](ExtensionHost.md) +- [ExtensionCli](ExtensionCli.md) +- [HttpService](HttpService.md) +- [RequestConfig](RequestConfig.md) +- [ServiceError](ServiceError.md) +- [DockerDesktopClient](DockerDesktopClient.md) diff --git a/data/toc.yaml b/data/toc.yaml index 2c0ed60b73..c32e141a2b 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -985,55 +985,57 @@ Reference: path: /reference/api/hub/deprecated/ - sectiontitle: Docker Extension SDK API section: - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ + - path: /reference/api/extensions-sdk/ + title: API Reference + - path: /reference/api/extensions-sdk/DesktopUI/ title: DesktopUI - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Dialog/ + - path: /reference/api/extensions-sdk/Dialog/ title: Dialog - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Docker/ + - path: /reference/api/extensions-sdk/Docker/ title: Docker - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand/ + - path: /reference/api/extensions-sdk/DockerCommand/ title: DockerCommand - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/ + - path: /reference/api/extensions-sdk/DockerDesktopClient/ title: DockerDesktopClient - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Exec/ + - path: /reference/api/extensions-sdk/Exec/ title: Exec - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess/ + - path: /reference/api/extensions-sdk/ExecProcess/ title: ExecProcess - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult/ + - path: /reference/api/extensions-sdk/ExecResult/ title: ExecResult - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/ + - path: /reference/api/extensions-sdk/ExecStreamOptions/ title: ExecStreamOptions - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Extension/ + - path: /reference/api/extensions-sdk/Extension/ title: Extension - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/ + - path: /reference/api/extensions-sdk/ExtensionCli/ title: ExtensionCli - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/ + - path: /reference/api/extensions-sdk/ExtensionHost/ title: ExtensionHost - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/ + - path: /reference/api/extensions-sdk/ExtensionVM/ title: ExtensionVM - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Host/ + - path: /reference/api/extensions-sdk/Host/ title: Host - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/HttpService/ + - path: /reference/api/extensions-sdk/HttpService/ title: HttpService - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/ + - path: /reference/api/extensions-sdk/NavigationIntents/ title: NavigationIntents - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/ + - path: /reference/api/extensions-sdk/OpenDialogResult/ title: OpenDialogResult - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult/ + - path: /reference/api/extensions-sdk/RawExecResult/ title: RawExecResult - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig/ + - path: /reference/api/extensions-sdk/RequestConfig/ title: RequestConfig - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/ + - path: /reference/api/extensions-sdk/RequestConfigV0/ title: RequestConfigV0 - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError/ + - path: /reference/api/extensions-sdk/ServiceError/ title: ServiceError - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError/ + - path: /reference/api/extensions-sdk/ServiceError/ title: SpawnOptions - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Toast/ + - path: /reference/api/extensions-sdk/Toast/ title: Toast - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/ + - path: /reference/api/extensions-sdk/ExecResultV0/ title: ExecResultV0 - - path: /extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0/ + - path: /reference/api/extensions-sdk/BackendV0/ title: BackendV0 - sectiontitle: Compose file reference section: @@ -1416,8 +1418,6 @@ Manuals: path: /extensions/extensions-sdk/dev/api/dashboard/ - title: Navigation path: /extensions/extensions-sdk/dev/api/dashboard-routes-navigation/ - - title: API Reference - path: /extensions/extensions-sdk/dev/api/reference/README/ - sectiontitle: Docker Scout section: