Update generated extension API reference from pinata#18357 (#14996)

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
This commit is contained in:
Guillaume Tardif 2022-06-24 09:22:23 +02:00 committed by GitHub
parent 2e059f0eee
commit 474c285845
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 214 additions and 464 deletions

View File

@ -1,18 +1,18 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
## Table of contents # Extensions API Reference
### Dashboard Interfaces ## Dashboard Interfaces
- [Host](interfaces/Host.md) - [Host](interfaces/Host.md)
- [NavigationIntents](interfaces/NavigationIntents.md) - [NavigationIntents](interfaces/NavigationIntents.md)
- [Toast](interfaces/Toast.md) - [Toast](interfaces/Toast.md)
### Other Interfaces ## Other Interfaces
- [ExecResultV0](interfaces/ExecResultV0.md) - [ExecResultV0](interfaces/ExecResultV0.md)
- [RequestConfigV0](interfaces/RequestConfigV0.md) - [RequestConfigV0](interfaces/RequestConfigV0.md)
@ -33,4 +33,5 @@ keywords: Docker, extensions, sdk, API, reference
- [ExtensionCli](interfaces/ExtensionCli.md) - [ExtensionCli](interfaces/ExtensionCli.md)
- [HttpService](interfaces/HttpService.md) - [HttpService](interfaces/HttpService.md)
- [RequestConfig](interfaces/RequestConfig.md) - [RequestConfig](interfaces/RequestConfig.md)
- [ServiceError](interfaces/ServiceError.md)
- [DockerDesktopClient](interfaces/DockerDesktopClient.md) - [DockerDesktopClient](interfaces/DockerDesktopClient.md)

View File

@ -1,32 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: BackendV0 # Interface: BackendV0
## Table of contents
### Container Methods
- [execInContainer](BackendV0.md#execincontainer)
### HTTP Methods
- [get](BackendV0.md#get)
- [post](BackendV0.md#post)
- [put](BackendV0.md#put)
- [patch](BackendV0.md#patch)
- [delete](BackendV0.md#delete)
- [head](BackendV0.md#head)
- [request](BackendV0.md#request)
### VM Methods
- [execInVMExtension](BackendV0.md#execinvmextension)
- [spawnInVMExtension](BackendV0.md#spawninvmextension)
## Container Methods ## Container Methods
### execInContainer ### execInContainer
@ -36,9 +15,9 @@ keywords: Docker, extensions, sdk, API, reference
Executes a command inside a container. Executes a command inside a container.
```typescript ```typescript
const output = await window.ddClient.backend.execInContainer(container, cmd); const output = await window.ddClient.backend.execInContainer(container, cmd);
console.log(output); console.log(output);
``` ```
**`deprecated`** :warning: It will be removed in a future version. **`deprecated`** :warning: It will be removed in a future version.
@ -67,7 +46,7 @@ Performs an HTTP GET request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.get("/some/service") .get("/some/service")
.then((value: any) => console.log(value) .then((value: any) => console.log(value));
``` ```
**`deprecated`** :warning: It will be removed in a future version. Use [HttpService.get](HttpService.md#get) instead. **`deprecated`** :warning: It will be removed in a future version. Use [HttpService.get](HttpService.md#get) instead.
@ -91,7 +70,7 @@ ___
Performs an HTTP POST request to a backend service. Performs an HTTP POST request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.post("/some/service", { ... }) .post("/some/service", { ... })
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -118,7 +97,7 @@ ___
Performs an HTTP PUT request to a backend service. Performs an HTTP PUT request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.put("/some/service", { ... }) .put("/some/service", { ... })
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -145,7 +124,7 @@ ___
Performs an HTTP PATCH request to a backend service. Performs an HTTP PATCH request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.patch("/some/service", { ... }) .patch("/some/service", { ... })
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -172,7 +151,7 @@ ___
Performs an HTTP DELETE request to a backend service. Performs an HTTP DELETE request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.delete("/some/service") .delete("/some/service")
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -198,7 +177,7 @@ ___
Performs an HTTP HEAD request to a backend service. Performs an HTTP HEAD request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.head("/some/service") .head("/some/service")
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -224,7 +203,7 @@ ___
Performs an HTTP request to a backend service. Performs an HTTP request to a backend service.
```typescript ```typescript
window.ddClient.backend window.ddClient.backend
.request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }}) .request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }})
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -253,11 +232,11 @@ Executes a command inside the backend container.
If your extensions ships with additional binaries that should be run inside the backend container you can use the `execInVMExtension` function. If your extensions ships with additional binaries that should be run inside the backend container you can use the `execInVMExtension` function.
```typescript ```typescript
const output = await window.ddClient.backend.execInVMExtension( const output = await window.ddClient.backend.execInVMExtension(
`cliShippedInTheVm xxx` `cliShippedInTheVm xxx`
); );
console.log(output); console.log(output);
``` ```
**`deprecated`** :warning: It will be removed in a future version. Use [ExtensionCli.exec](ExtensionCli.md#exec) instead. **`deprecated`** :warning: It will be removed in a future version. Use [ExtensionCli.exec](ExtensionCli.md#exec) instead.

View File

@ -1,19 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: DesktopUI # Interface: DesktopUI
## Table of contents
### Properties
- [toast](DesktopUI.md#toast)
- [dialog](DesktopUI.md#dialog)
- [navigate](DesktopUI.md#navigate)
## Properties ## Properties
### toast ### toast

View File

@ -1,19 +1,13 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: Dialog # Interface: Dialog
Allows opening native dialog boxes. Allows opening native dialog boxes.
## Table of contents
### Methods
- [showOpenDialog](Dialog.md#showopendialog)
## Methods ## Methods
### showOpenDialog ### showOpenDialog

View File

@ -1,22 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: Docker # Interface: Docker
## Table of contents
### Properties
- [cli](Docker.md#cli)
### Methods
- [listContainers](Docker.md#listcontainers)
- [listImages](Docker.md#listimages)
## Properties ## Properties
### cli ### cli
@ -26,23 +15,23 @@ keywords: Docker, extensions, sdk, API, reference
You can also directly execute the docker binary. You can also directly execute the docker binary.
```typescript ```typescript
const output = await ddClient.docker.cli.exec("info", [ const output = await ddClient.docker.cli.exec("volume", [
"--format", "ls",
{% raw %}'"{{ json . }}"',{% endraw %} "--filter",
"dangling=true"
]); ]);
``` ```
Output: Output:
``` ```json
{ {
"stderr": "...", "stderr": "...",
"stdout": "..." "stdout": "..."
} }
``` ```
In this example the docker command output is a json output. For convenience, the command result object also has methods to easily parse it depending on output format. See [ExecResult](ExecResult.md) instead.
For convenience, the command result object also has methods to easily parse it. See [ExecResult](ExecResult.md) instead.
--- ---
@ -91,14 +80,14 @@ const containers = await ddClient.docker.listContainers();
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------- | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `options?` | `any` | (Optional). A JSON like `{ "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#operation/ContainerList). | | `options?` | `any` | (Optional). A JSON like `{ "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#operation/ContainerList). |
#### Returns #### Returns
`Promise`<`unknown`\> `Promise`<`unknown`\>
--- ___
### listImages ### listImages
@ -113,7 +102,7 @@ const images = await ddClient.docker.listImages();
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------- | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | :------ | :------ | :------ |
| `options?` | `any` | (Optional). A JSON like `{ "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#tag/Image). | | `options?` | `any` | (Optional). A JSON like `{ "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#tag/Image). |
#### Returns #### Returns

View File

@ -1,17 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: DockerCommand # Interface: DockerCommand
## Table of contents
### Properties
- [exec](DockerCommand.md#exec)
## Properties ## Properties
### exec ### exec

View File

@ -1,60 +1,14 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: DockerDesktopClient # Interface: DockerDesktopClient
When we moved from the v0 to v1 schema, we made sure An amalgam of the v0 and v1 interfaces of the Docker Desktop API client,
window.ddClient satisfied both interfaces. This combined type provided for backwards compatibility reasons. Unless you're working with
describes the resulting API. We should delete it when we stop providing a legacy extension, use the v1 type instead.
the v0 API.
## Table of contents
### Properties
- [backend](DockerDesktopClient.md#backend)
- [extension](DockerDesktopClient.md#extension)
- [desktopUI](DockerDesktopClient.md#desktopui)
- [host](DockerDesktopClient.md#host)
- [docker](DockerDesktopClient.md#docker)
### Container Methods
- [listContainers](DockerDesktopClient.md#listcontainers)
### Image Methods
- [listImages](DockerDesktopClient.md#listimages)
### Navigation Methods
- [navigateToContainers](DockerDesktopClient.md#navigatetocontainers)
- [navigateToContainer](DockerDesktopClient.md#navigatetocontainer)
- [navigateToContainerLogs](DockerDesktopClient.md#navigatetocontainerlogs)
- [navigateToContainerInspect](DockerDesktopClient.md#navigatetocontainerinspect)
- [navigateToContainerStats](DockerDesktopClient.md#navigatetocontainerstats)
- [navigateToImages](DockerDesktopClient.md#navigatetoimages)
- [navigateToImage](DockerDesktopClient.md#navigatetoimage)
- [navigateToVolumes](DockerDesktopClient.md#navigatetovolumes)
- [navigateToVolume](DockerDesktopClient.md#navigatetovolume)
- [navigateToDevEnvironments](DockerDesktopClient.md#navigatetodevenvironments)
### Other Methods
- [execHostCmd](DockerDesktopClient.md#exechostcmd)
- [spawnHostCmd](DockerDesktopClient.md#spawnhostcmd)
- [execDockerCmd](DockerDesktopClient.md#execdockercmd)
- [spawnDockerCmd](DockerDesktopClient.md#spawndockercmd)
- [openExternal](DockerDesktopClient.md#openexternal)
### Toast Methods
- [toastSuccess](DockerDesktopClient.md#toastsuccess)
- [toastWarning](DockerDesktopClient.md#toastwarning)
- [toastError](DockerDesktopClient.md#toasterror)
## Properties ## Properties
@ -72,7 +26,7 @@ The client is already connected to the backend.
DockerDesktopClientV0.backend DockerDesktopClientV0.backend
--- ___
### extension ### extension
@ -86,7 +40,7 @@ The client is already connected to the backend.
DockerDesktopClientV1.extension DockerDesktopClientV1.extension
--- ___
### desktopUI ### desktopUI
@ -96,7 +50,7 @@ DockerDesktopClientV1.extension
DockerDesktopClientV1.desktopUI DockerDesktopClientV1.desktopUI
--- ___
### host ### host
@ -106,7 +60,7 @@ DockerDesktopClientV1.desktopUI
DockerDesktopClientV1.host DockerDesktopClientV1.host
--- ___
### docker ### docker
@ -136,7 +90,7 @@ const containers = await window.ddClient.listContainers();
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :-------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `options` | `never` | (Optional). A JSON like `{ "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#operation/ContainerList). | | `options` | `never` | (Optional). A JSON like `{ "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#operation/ContainerList). |
#### Returns #### Returns
@ -147,7 +101,7 @@ const containers = await window.ddClient.listContainers();
DockerDesktopClientV0.listContainers DockerDesktopClientV0.listContainers
--- ___
## Image Methods ## Image Methods
@ -166,7 +120,7 @@ const images = await window.ddClient.listImages();
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :-------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | :------ | :------ | :------ |
| `options` | `never` | (Optional). A JSON like `{ "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#tag/Image). | | `options` | `never` | (Optional). A JSON like `{ "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true }` For more information about the different properties see [the Docker API endpoint documentation](https://docs.docker.com/engine/api/v1.37/#tag/Image). |
#### Returns #### Returns
@ -177,7 +131,7 @@ const images = await window.ddClient.listImages();
DockerDesktopClientV0.listImages DockerDesktopClientV0.listImages
--- ___
## Navigation Methods ## Navigation Methods
@ -186,7 +140,6 @@ DockerDesktopClientV0.listImages
**navigateToContainers**(): `void` **navigateToContainers**(): `void`
Navigate to the containers window in Docker Desktop. Navigate to the containers window in Docker Desktop.
```typescript ```typescript
window.ddClient.navigateToContainers(); window.ddClient.navigateToContainers();
``` ```
@ -201,14 +154,13 @@ window.ddClient.navigateToContainers();
DockerDesktopClientV0.navigateToContainers DockerDesktopClientV0.navigateToContainers
--- ___
### navigateToContainer ### navigateToContainer
**navigateToContainer**(`id`): `Promise`<`any`\> **navigateToContainer**(`id`): `Promise`<`any`\>
Navigate to the container window in Docker Desktop. Navigate to the container window in Docker Desktop.
```typescript ```typescript
await window.ddClient.navigateToContainer(id); await window.ddClient.navigateToContainer(id);
``` ```
@ -218,7 +170,7 @@ await window.ddClient.navigateToContainer(id);
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. | | `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. |
#### Returns #### Returns
@ -231,14 +183,13 @@ A promise that fails if the container doesn't exist.
DockerDesktopClientV0.navigateToContainer DockerDesktopClientV0.navigateToContainer
--- ___
### navigateToContainerLogs ### navigateToContainerLogs
**navigateToContainerLogs**(`id`): `Promise`<`any`\> **navigateToContainerLogs**(`id`): `Promise`<`any`\>
Navigate to the container logs window in Docker Desktop. Navigate to the container logs window in Docker Desktop.
```typescript ```typescript
await window.ddClient.navigateToContainerLogs(id); await window.ddClient.navigateToContainerLogs(id);
``` ```
@ -248,7 +199,7 @@ await window.ddClient.navigateToContainerLogs(id);
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. | | `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. |
#### Returns #### Returns
@ -261,14 +212,13 @@ A promise that fails if the container doesn't exist.
DockerDesktopClientV0.navigateToContainerLogs DockerDesktopClientV0.navigateToContainerLogs
--- ___
### navigateToContainerInspect ### navigateToContainerInspect
**navigateToContainerInspect**(`id`): `Promise`<`any`\> **navigateToContainerInspect**(`id`): `Promise`<`any`\>
Navigate to the container inspect window in Docker Desktop. Navigate to the container inspect window in Docker Desktop.
```typescript ```typescript
await window.ddClient.navigateToContainerInspect(id); await window.ddClient.navigateToContainerInspect(id);
``` ```
@ -278,7 +228,7 @@ await window.ddClient.navigateToContainerInspect(id);
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. | | `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. |
#### Returns #### Returns
@ -291,7 +241,7 @@ A promise that fails if the container doesn't exist.
DockerDesktopClientV0.navigateToContainerInspect DockerDesktopClientV0.navigateToContainerInspect
--- ___
### navigateToContainerStats ### navigateToContainerStats
@ -308,7 +258,7 @@ await window.ddClient.navigateToContainerStats(id);
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. | | `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. |
#### Returns #### Returns
@ -321,14 +271,13 @@ A promise that fails if the container doesn't exist.
DockerDesktopClientV0.navigateToContainerStats DockerDesktopClientV0.navigateToContainerStats
--- ___
### navigateToImages ### navigateToImages
**navigateToImages**(): `void` **navigateToImages**(): `void`
Navigate to the images window in Docker Desktop. Navigate to the images window in Docker Desktop.
```typescript ```typescript
await window.ddClient.navigateToImages(id); await window.ddClient.navigateToImages(id);
``` ```
@ -343,7 +292,7 @@ await window.ddClient.navigateToImages(id);
DockerDesktopClientV0.navigateToImages DockerDesktopClientV0.navigateToImages
--- ___
### navigateToImage ### navigateToImage
@ -361,7 +310,7 @@ await window.ddClient.navigateToImage(id, tag);
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :---- | :------- | :----------------------------------------------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `id` | `string` | The full image id (including sha), e.g. `sha256:34ab3ae068572f4e85c448b4035e6be5e19cc41f69606535cd4d768a63432673`. | | `id` | `string` | The full image id (including sha), e.g. `sha256:34ab3ae068572f4e85c448b4035e6be5e19cc41f69606535cd4d768a63432673`. |
| `tag` | `string` | The tag of the image, e.g. `latest`, `0.0.1`, etc. | | `tag` | `string` | The tag of the image, e.g. `latest`, `0.0.1`, etc. |
@ -375,7 +324,7 @@ A promise that fails if the container doesn't exist.
DockerDesktopClientV0.navigateToImage DockerDesktopClientV0.navigateToImage
--- ___
### navigateToVolumes ### navigateToVolumes
@ -397,7 +346,7 @@ await window.ddClient.navigateToVolumes();
DockerDesktopClientV0.navigateToVolumes DockerDesktopClientV0.navigateToVolumes
--- ___
### navigateToVolume ### navigateToVolume
@ -414,7 +363,7 @@ window.ddClient.navigateToVolume(volume);
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------- | :------- | :---------------------------------------- | | :------ | :------ | :------ |
| `volume` | `string` | The name of the volume, e.g. `my-volume`. | | `volume` | `string` | The name of the volume, e.g. `my-volume`. |
#### Returns #### Returns
@ -425,7 +374,7 @@ window.ddClient.navigateToVolume(volume);
DockerDesktopClientV0.navigateToVolume DockerDesktopClientV0.navigateToVolume
--- ___
### navigateToDevEnvironments ### navigateToDevEnvironments
@ -447,7 +396,7 @@ window.ddClient.navigateToDevEnvironments();
DockerDesktopClientV0.navigateToDevEnvironments DockerDesktopClientV0.navigateToDevEnvironments
--- ___
## Other Methods ## Other Methods
@ -468,7 +417,7 @@ window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => {
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :---- | :------- | :-------------------------- | | :------ | :------ | :------ |
| `cmd` | `string` | The command to be executed. | | `cmd` | `string` | The command to be executed. |
#### Returns #### Returns
@ -479,7 +428,7 @@ window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => {
DockerDesktopClientV0.execHostCmd DockerDesktopClientV0.execHostCmd
--- ___
### spawnHostCmd ### spawnHostCmd
@ -506,7 +455,7 @@ window.ddClient.spawnHostCmd(
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :--------- | :---------------------------------------- | :----------------------------------------------------------------------------- | | :------ | :------ | :------ |
| `cmd` | `string` | The command to be executed. | | `cmd` | `string` | The command to be executed. |
| `args` | `string`[] | The arguments of the command to execute. | | `args` | `string`[] | The arguments of the command to execute. |
| `callback` | (`data`: `any`, `error`: `any`) => `void` | The callback function where to listen from the command output data and errors. | | `callback` | (`data`: `any`, `error`: `any`) => `void` | The callback function where to listen from the command output data and errors. |
@ -519,7 +468,7 @@ window.ddClient.spawnHostCmd(
DockerDesktopClientV0.spawnHostCmd DockerDesktopClientV0.spawnHostCmd
--- ___
### execDockerCmd ### execDockerCmd
@ -528,11 +477,7 @@ DockerDesktopClientV0.spawnHostCmd
You can also directly execute the docker binary. You can also directly execute the docker binary.
```typescript ```typescript
const output = await window.ddClient.execDockerCmd( const output = await window.ddClient.execDockerCmd("info");
"info",
"--format",
{% raw %}'"{{ json . }}"'{% endraw %}
);
``` ```
**`deprecated`** :warning: It will be removed in a future version. Use [DockerCommand.exec](DockerCommand.md#exec) instead. **`deprecated`** :warning: It will be removed in a future version. Use [DockerCommand.exec](DockerCommand.md#exec) instead.
@ -540,7 +485,7 @@ const output = await window.ddClient.execDockerCmd(
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :-------- | :--------- | :--------------------------------------- | | :------ | :------ | :------ |
| `cmd` | `string` | The command to execute. | | `cmd` | `string` | The command to execute. |
| `...args` | `string`[] | The arguments of the command to execute. | | `...args` | `string`[] | The arguments of the command to execute. |
@ -549,17 +494,13 @@ const output = await window.ddClient.execDockerCmd(
`Promise`<[`ExecResultV0`](ExecResultV0.md)\> `Promise`<[`ExecResultV0`](ExecResultV0.md)\>
The result will contain both the standard output and the standard error of the executed command: The result will contain both the standard output and the standard error of the executed command:
```json
```
{ {
"stderr": "...", "stderr": "...",
"stdout": "..." "stdout": "..."
} }
``` ```
For convenience, the command result object also has methods to easily parse it depending on the output format:
In this example the docker command output is a json output.
For convenience, the command result object also has methods to easily parse it:
- `output.lines(): string[]` splits output lines. - `output.lines(): string[]` splits output lines.
- `output.parseJsonObject(): any` parses a well-formed json output. - `output.parseJsonObject(): any` parses a well-formed json output.
@ -578,7 +519,7 @@ window.ddClient.spawnDockerCmd("logs", ["-f", "..."], (data, error) => {
DockerDesktopClientV0.execDockerCmd DockerDesktopClientV0.execDockerCmd
--- ___
### spawnDockerCmd ### spawnDockerCmd
@ -589,7 +530,7 @@ DockerDesktopClientV0.execDockerCmd
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :--------- | :---------------------------------------- | | :------ | :------ |
| `cmd` | `string` | | `cmd` | `string` |
| `args` | `string`[] | | `args` | `string`[] |
| `callback` | (`data`: `any`, `error`: `any`) => `void` | | `callback` | (`data`: `any`, `error`: `any`) => `void` |
@ -602,7 +543,7 @@ DockerDesktopClientV0.execDockerCmd
DockerDesktopClientV0.spawnDockerCmd DockerDesktopClientV0.spawnDockerCmd
--- ___
### openExternal ### openExternal
@ -619,7 +560,7 @@ window.ddClient.openExternal("https://docker.com");
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :---- | :------- | :------------------------------------------------------------------------ | | :------ | :------ | :------ |
| `url` | `string` | The URL the browser will open (must have the protocol `http` or `https`). | | `url` | `string` | The URL the browser will open (must have the protocol `http` or `https`). |
#### Returns #### Returns
@ -630,7 +571,7 @@ window.ddClient.openExternal("https://docker.com");
DockerDesktopClientV0.openExternal DockerDesktopClientV0.openExternal
--- ___
## Toast Methods ## Toast Methods
@ -649,7 +590,7 @@ window.ddClient.toastSuccess("message");
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :---- | :------- | :----------------------------------- | | :------ | :------ | :------ |
| `msg` | `string` | The message to display in the toast. | | `msg` | `string` | The message to display in the toast. |
#### Returns #### Returns
@ -660,7 +601,7 @@ window.ddClient.toastSuccess("message");
DockerDesktopClientV0.toastSuccess DockerDesktopClientV0.toastSuccess
--- ___
### toastWarning ### toastWarning
@ -677,7 +618,7 @@ window.ddClient.toastWarning("message");
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :---- | :------- | :----------------------------------- | | :------ | :------ | :------ |
| `msg` | `string` | The message to display in the toast. | | `msg` | `string` | The message to display in the toast. |
#### Returns #### Returns
@ -688,7 +629,7 @@ window.ddClient.toastWarning("message");
DockerDesktopClientV0.toastWarning DockerDesktopClientV0.toastWarning
--- ___
### toastError ### toastError
@ -705,7 +646,7 @@ window.ddClient.toastError("message");
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :---- | :------- | :----------------------------------- | | :------ | :------ | :------ |
| `msg` | `string` | The message to display in the toast. | | `msg` | `string` | The message to display in the toast. |
#### Returns #### Returns

View File

@ -1,7 +1,7 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: Exec # Interface: Exec

View File

@ -1,17 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExecProcess # Interface: ExecProcess
## Table of contents
### Methods
- [close](ExecProcess.md#close)
## Methods ## Methods
### close ### close

View File

@ -1,7 +1,7 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExecResult # Interface: ExecResult
@ -12,23 +12,6 @@ keywords: Docker, extensions, sdk, API, reference
**`ExecResult`** **`ExecResult`**
## Table of contents
### Methods
- [lines](ExecResult.md#lines)
- [parseJsonLines](ExecResult.md#parsejsonlines)
- [parseJsonObject](ExecResult.md#parsejsonobject)
### Properties
- [cmd](ExecResult.md#cmd)
- [killed](ExecResult.md#killed)
- [signal](ExecResult.md#signal)
- [code](ExecResult.md#code)
- [stdout](ExecResult.md#stdout)
- [stderr](ExecResult.md#stderr)
## Methods ## Methods
### lines ### lines

View File

@ -1,28 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExecResultV0 # Interface: ExecResultV0
## Table of contents
### Properties
- [cmd](ExecResultV0.md#cmd)
- [killed](ExecResultV0.md#killed)
- [signal](ExecResultV0.md#signal)
- [code](ExecResultV0.md#code)
- [stdout](ExecResultV0.md#stdout)
- [stderr](ExecResultV0.md#stderr)
### Methods
- [lines](ExecResultV0.md#lines)
- [parseJsonLines](ExecResultV0.md#parsejsonlines)
- [parseJsonObject](ExecResultV0.md#parsejsonobject)
## Properties ## Properties
### cmd ### cmd

View File

@ -1,23 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExecStreamOptions # Interface: ExecStreamOptions
## Table of contents
### Methods
- [onOutput](ExecStreamOptions.md#onoutput)
- [onError](ExecStreamOptions.md#onerror)
- [onClose](ExecStreamOptions.md#onclose)
### Properties
- [splitOutputLines](ExecStreamOptions.md#splitoutputlines)
## Methods ## Methods
### onOutput ### onOutput

View File

@ -1,18 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: Extension # Interface: Extension
## Table of contents
### Properties
- [vm](Extension.md#vm)
- [host](Extension.md#host)
## Properties ## Properties
### vm ### vm

View File

@ -1,17 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExtensionCli # Interface: ExtensionCli
## Table of contents
### Properties
- [exec](ExtensionCli.md#exec)
## Properties ## Properties
### exec ### exec

View File

@ -1,17 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExtensionHost # Interface: ExtensionHost
## Table of contents
### Properties
- [cli](ExtensionHost.md#cli)
## Properties ## Properties
### cli ### cli
@ -53,5 +47,5 @@ await ddClient.extension.host.cli.exec("kubectl", ["-h"], {
console.log("onClose with exit code " + exitCode); console.log("onClose with exit code " + exitCode);
}, },
}, },
}); });
``` ```

View File

@ -1,18 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: ExtensionVM # Interface: ExtensionVM
## Table of contents
### Properties
- [cli](ExtensionVM.md#cli)
- [service](ExtensionVM.md#service)
## Properties ## Properties
### cli ### cli
@ -24,7 +17,10 @@ Executes a command in the backend container.
Example: Execute the command `ls -l` inside the **backend container**: Example: Execute the command `ls -l` inside the **backend container**:
```typescript ```typescript
await ddClient.extension.vm.cli.exec("ls", ["-l"]); await ddClient.extension.vm.cli.exec(
"ls",
["-l"]
);
``` ```
Streams the output of the command executed in the backend container. Streams the output of the command executed in the backend container.
@ -52,7 +48,7 @@ await ddClient.extension.vm.cli.exec("ls", ["-l"], {
console.log("onClose with exit code " + exitCode); console.log("onClose with exit code " + exitCode);
}, },
}, },
}); });
``` ```
**`param`** Command to execute. **`param`** Command to execute.
@ -61,7 +57,7 @@ await ddClient.extension.vm.cli.exec("ls", ["-l"], {
**`param`** The callback function where to listen from the command output data and errors. **`param`** The callback function where to listen from the command output data and errors.
--- ___
### service ### service

View File

@ -1,23 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: Host # Interface: Host
## Table of contents
### Methods
- [openExternal](Host.md#openexternal)
### Properties
- [platform](Host.md#platform)
- [arch](Host.md#arch)
- [hostname](Host.md#hostname)
## Methods ## Methods
### openExternal ### openExternal

View File

@ -1,23 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: HttpService # Interface: HttpService
## Table of contents
### Methods
- [get](HttpService.md#get)
- [post](HttpService.md#post)
- [put](HttpService.md#put)
- [patch](HttpService.md#patch)
- [delete](HttpService.md#delete)
- [head](HttpService.md#head)
- [request](HttpService.md#request)
## Methods ## Methods
### get ### get
@ -27,7 +15,7 @@ keywords: Docker, extensions, sdk, API, reference
Performs an HTTP GET request to a backend service. Performs an HTTP GET request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.get("/some/service") .get("/some/service")
.then((value: any) => console.log(value) .then((value: any) => console.log(value)
``` ```
@ -51,7 +39,7 @@ ___
Performs an HTTP POST request to a backend service. Performs an HTTP POST request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.post("/some/service", { ... }) .post("/some/service", { ... })
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -76,7 +64,7 @@ ___
Performs an HTTP PUT request to a backend service. Performs an HTTP PUT request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.put("/some/service", { ... }) .put("/some/service", { ... })
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -101,7 +89,7 @@ ___
Performs an HTTP PATCH request to a backend service. Performs an HTTP PATCH request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.patch("/some/service", { ... }) .patch("/some/service", { ... })
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -126,7 +114,7 @@ ___
Performs an HTTP DELETE request to a backend service. Performs an HTTP DELETE request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.delete("/some/service") .delete("/some/service")
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -150,7 +138,7 @@ ___
Performs an HTTP HEAD request to a backend service. Performs an HTTP HEAD request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.head("/some/service") .head("/some/service")
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```
@ -174,7 +162,7 @@ ___
Performs an HTTP request to a backend service. Performs an HTTP request to a backend service.
```typescript ```typescript
ddClient.extension.vm.service ddClient.extension.vm.service
.request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }}) .request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }})
.then((value: any) => console.log(value)); .then((value: any) => console.log(value));
``` ```

View File

@ -1,35 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: NavigationIntents # Interface: NavigationIntents
## Table of contents
### Container Methods
- [viewContainers](NavigationIntents.md#viewcontainers)
- [viewContainer](NavigationIntents.md#viewcontainer)
- [viewContainerLogs](NavigationIntents.md#viewcontainerlogs)
- [viewContainerInspect](NavigationIntents.md#viewcontainerinspect)
- [viewContainerStats](NavigationIntents.md#viewcontainerstats)
### Images Methods
- [viewImages](NavigationIntents.md#viewimages)
- [viewImage](NavigationIntents.md#viewimage)
### Other Methods
- [viewDevEnvironments](NavigationIntents.md#viewdevenvironments)
### Volume Methods
- [viewVolumes](NavigationIntents.md#viewvolumes)
- [viewVolume](NavigationIntents.md#viewvolume)
## Container Methods ## Container Methods
### viewContainers ### viewContainers

View File

@ -1,19 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: OpenDialogResult # Interface: OpenDialogResult
## Table of contents
### Properties
- [canceled](OpenDialogResult.md#canceled)
- [filePaths](OpenDialogResult.md#filepaths)
- [bookmarks](OpenDialogResult.md#bookmarks)
## Properties ## Properties
### canceled ### canceled

View File

@ -1,7 +1,7 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: RawExecResult # Interface: RawExecResult
@ -12,17 +12,6 @@ keywords: Docker, extensions, sdk, API, reference
↳ [`ExecResult`](ExecResult.md) ↳ [`ExecResult`](ExecResult.md)
## Table of contents
### Properties
- [cmd](RawExecResult.md#cmd)
- [killed](RawExecResult.md#killed)
- [signal](RawExecResult.md#signal)
- [code](RawExecResult.md#code)
- [stdout](RawExecResult.md#stdout)
- [stderr](RawExecResult.md#stderr)
## Properties ## Properties
### cmd ### cmd

View File

@ -1,20 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: RequestConfig # Interface: RequestConfig
## Table of contents
### Properties
- [url](RequestConfig.md#url)
- [method](RequestConfig.md#method)
- [headers](RequestConfig.md#headers)
- [data](RequestConfig.md#data)
## Properties ## Properties
### url ### url

View File

@ -1,20 +1,11 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: RequestConfigV0 # Interface: RequestConfigV0
## Table of contents
### Properties
- [url](RequestConfigV0.md#url)
- [method](RequestConfigV0.md#method)
- [headers](RequestConfigV0.md#headers)
- [data](RequestConfigV0.md#data)
## Properties ## Properties
### url ### url

View File

@ -0,0 +1,28 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---
# Interface: ServiceError
Error thrown when an HTTP response is received with a status code that falls
out to the range of 2xx.
## Properties
### name
**name**: `string`
___
### message
**message**: `string`
___
### statusCode
**statusCode**: `number`

View File

@ -1,7 +1,7 @@
--- ---
title: Docker extension API reference
description: Docker extension API reference description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
--- ---
# Interface: Toast # Interface: Toast
@ -10,14 +10,6 @@ Toasts provide a brief notification to the user.
They appear temporarily and shouldn't interrupt the user experience. They appear temporarily and shouldn't interrupt the user experience.
They also don't require user input to disappear. They also don't require user input to disappear.
## Table of contents
### Methods
- [success](Toast.md#success)
- [warning](Toast.md#warning)
- [error](Toast.md#error)
## Methods ## Methods
### success ### success