Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/extensions/extensions-sdk/dev/api/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
>
Expand Down Expand Up @@ -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
>
Expand Down Expand Up @@ -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
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
>
Expand Down
6 changes: 3 additions & 3 deletions content/extensions/extensions-sdk/dev/api/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
>
Expand All @@ -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.

Expand All @@ -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
>
Expand Down
6 changes: 3 additions & 3 deletions content/extensions/extensions-sdk/dev/api/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
>
Expand All @@ -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", [
Expand Down Expand Up @@ -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
>
Expand Down
2 changes: 1 addition & 1 deletion content/extensions/extensions-sdk/dev/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
40 changes: 0 additions & 40 deletions content/extensions/extensions-sdk/dev/api/reference/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
41 changes: 41 additions & 0 deletions content/reference/api/extensions-sdk/_index.md
Original file line number Diff line number Diff line change
@@ -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)
Loading