Skip to content

Commit bcc0a9c

Browse files
aevesdockeraevesdocker
authored
move extensions-sdk api content to reference (#20694)
* move extensions-sdk api content to reference * review suggestion * rename file
1 parent d7b4d1f commit bcc0a9c

34 files changed

+105
-78
lines changed

‎content/extensions/extensions-sdk/dev/api/backend.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ddClient.extension.vm.service
2020
.then((value: any) => console.log(value)
2121
```
2222
23-
See [Service API Reference](reference/interfaces/HttpService.md) for other methods such as POST, UPDATE, and DELETE.
23+
See [Service API Reference](/reference/api/extensions-sdk/HttpService.md) for other methods such as POST, UPDATE, and DELETE.
2424
2525
> Deprecated extension backend communication
2626
>
@@ -92,7 +92,7 @@ await ddClient.extension.vm.cli.exec("ls", ["-l"], {
9292
});
9393
```
9494
95-
For more details, refer to the [Extension VM API Reference](reference/interfaces/ExtensionVM.md)
95+
For more details, refer to the [Extension VM API Reference](/reference/api/extensions-sdk/ExtensionVM.md)
9696
9797
> Deprecated extension backend command execution
9898
>
@@ -143,7 +143,7 @@ await ddClient.extension.host.cli.exec("kubectl", ["-h"], {
143143
144144
You can stream the output of the command executed in the backend container or in the host.
145145
146-
For more details, refer to the [Extension Host API Reference](reference/interfaces/ExtensionHost.md)
146+
For more details, refer to the [Extension Host API Reference](/reference/api/extensions-sdk/ExtensionHost.md)
147147
148148
> Deprecated invocation of extension binary
149149
>

‎content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ try {
3434

3535
A promise that fails if the container doesn't exist.
3636

37-
For more details about all navigation methods, see the [Navigation API reference](reference/interfaces/NavigationIntents.md).
37+
For more details about all navigation methods, see the [Navigation API reference](/reference/api/extensions-sdk/NavigationIntents.md).
3838

3939
> Deprecated navigation methods
4040
>

‎content/extensions/extensions-sdk/dev/api/dashboard.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Use to display a toast message of type error.
4141
ddClient.desktopUI.toast.error("message");
4242
```
4343

44-
For more details about method parameters and the return types available, see [Toast API reference](reference/interfaces/Toast.md).
44+
For more details about method parameters and the return types available, see [Toast API reference](/reference/api/extensions-sdk/Toast.md).
4545

4646
> Deprecated user notifications
4747
>
@@ -57,7 +57,7 @@ window.ddClient.toastError("message");
5757

5858
This function opens a file selector dialog that asks the user to select a file or folder.
5959

60-
▸ **showOpenDialog**(`dialogProperties`): `Promise`<[`OpenDialogResult`](reference/interfaces/OpenDialogResult.md)\>:
60+
▸ **showOpenDialog**(`dialogProperties`): `Promise`<[`OpenDialogResult`](/reference/api/extensions-sdk/OpenDialogResult.md)\>:
6161

6262
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.
6363

@@ -82,7 +82,7 @@ ddClient.host.openExternal("https://docker.com");
8282

8383
> The URL must have the protocol `http` or `https`.
8484
85-
For more details about method parameters and the return types available, see [Desktop host API reference](reference/interfaces/Host.md).
85+
For more details about method parameters and the return types available, see [Desktop host API reference](/reference/api/extensions-sdk/Host.md).
8686

8787
> Deprecated user notifications
8888
>

‎content/extensions/extensions-sdk/dev/api/docker.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To get the list of local container images:
2424
const images = await ddClient.docker.listImages();
2525
```
2626

27-
See the [Docker API reference](reference/interfaces/Docker.md) for details about these methods.
27+
See the [Docker API reference](/reference/api/extensions-sdk/Docker.md) for details about these methods.
2828

2929
> Deprecated access to Docker objects
3030
>
@@ -40,7 +40,7 @@ const images = await window.ddClient.listImages();
4040

4141
Extensions can also directly execute the `docker` command line.
4242

43-
▸ **exec**(`cmd`, `args`): `Promise`<[`ExecResult`](reference/interfaces/ExecResult.md)\>
43+
▸ **exec**(`cmd`, `args`): `Promise`<[`ExecResult`](/reference/api/extensions-sdk/ExecResult.md)\>
4444

4545
```typescript
4646
const result = await ddClient.docker.cli.exec("info", [
@@ -136,7 +136,7 @@ await ddClient.docker.cli.exec(
136136
>
137137
> You need to invoke `exec()` for each command and parse results to pass parameters to the next command if needed.
138138
139-
See the [Exec API reference](reference/interfaces/Exec.md) for details about these methods.
139+
See the [Exec API reference](/reference/api/extensions-sdk/Exec.md) for details about these methods.
140140

141141
> Deprecated execution of Docker commands
142142
>

‎content/extensions/extensions-sdk/dev/api/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ The `ddClient` object gives access to various APIs:
3434
- [Dashboard](dashboard.md)
3535
- [Navigation](dashboard-routes-navigation.md)
3636

37-
Find the Extensions API reference [here](reference/README.md).
37+
Find the Extensions API reference [here](reference/api/extensions-sdk/_index.md).

‎content/extensions/extensions-sdk/dev/api/reference/README.md‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md‎ renamed to ‎content/reference/api/extensions-sdk/BackendV0.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ description: Docker extension API reference
33
keywords: Docker, extensions, sdk, API, reference
44
aliases:
55
- /desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0/
6+
- /extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0/
67
---
78

89
# Interface: BackendV0

‎content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md‎ renamed to ‎content/reference/api/extensions-sdk/DesktopUI.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ description: Docker extension API reference
33
keywords: Docker, extensions, sdk, API, reference
44
aliases:
55
- /desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI/
6+
- /extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI/
67
---
78

89
# Interface: DesktopUI

‎content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md‎ renamed to ‎content/reference/api/extensions-sdk/Dialog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ description: Docker extension API reference
33
keywords: Docker, extensions, sdk, API, reference
44
aliases:
55
- /desktop/extensions-sdk/dev/api/reference/interfaces/Dialog/
6+
- /extensions/extensions-sdk/dev/api/reference/interfaces/Dialog/
67
---
78

89
# Interface: Dialog

‎content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md‎ renamed to ‎content/reference/api/extensions-sdk/Docker.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ description: Docker extension API reference
33
keywords: Docker, extensions, sdk, API, reference
44
aliases:
55
- /desktop/extensions-sdk/dev/api/reference/interfaces/Docker/
6+
- /extensions/extensions-sdk/dev/api/reference/interfaces/Docker/
67
---
78

89
# Interface: Docker

0 commit comments

Comments
 (0)