move extensions-sdk api content to reference (#20694)

* move extensions-sdk api content to reference

* review suggestion

* rename file
This commit is contained in:
Allie Sadler 2024-08-23 14:41:17 +01:00 committed by GitHub
parent d7b4d1f288
commit bcc0a9c9a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
34 changed files with 105 additions and 78 deletions

View File

@ -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
>

View File

@ -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
>

View File

@ -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
>

View File

@ -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
>

View File

@ -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).

View File

@ -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)

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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)

View File

@ -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: