Skip to content

Commit 89cd128

Browse files
authored
Merge pull request #103 from gtardif/minor_backend_section_changes
Minor backend section changes
2 parents a60b99c + 1f00e97 commit 89cd128

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

docs/dev/api/backend.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Communication with the backend
1+
## Communication with the extension backend
22

33
The `window.ddClient.extension.vm` object can be used to communicate with the backend defined in the [vm section](../../extensions/METADATA.md#vm-section) in the extensions metadata.
44

@@ -16,7 +16,7 @@ window.ddClient.extension.vm.service
1616
1717
Other methods for POST, UPDATE, DELETE, etc. are available, see [Service API Reference](reference/interfaces/http_service.HttpService.md#Methods)
1818
19-
### Deprecated backend communication
19+
### Deprecated extension backend communication
2020
2121
!!! warning "Methods deprecated"
2222
@@ -58,7 +58,7 @@ window.ddClient.backend
5858
.then((value: any) => console.log(value));
5959
```
6060
61-
## Running a command in the backend container
61+
## Running a command in the extension backend container
6262
6363
Executes a command in the backend container.
6464
@@ -88,7 +88,9 @@ await window.ddClient.extension.vm.cli.exec("ls", ["-l"], {
8888
});
8989
```
9090
91-
### Deprecated backend command execution
91+
For more details, please refer to the [Extension VM API Reference](reference/interfaces/extension.ExtensionVM.md)
92+
93+
### Deprecated extension backend command execution
9294
9395
!!! warning "Method deprecated"
9496
@@ -135,6 +137,8 @@ await window.ddClient.extension.host.cli.exec("kubectl", ["-h"], {
135137
136138
Streams the output of the command executed in the backend container or in the host.
137139
140+
For more details, please refer to the [Extension Host API Reference](reference/interfaces/extension.ExtensionHost.md)
141+
138142
### Deprecated invocation of extension binary
139143
140144
!!! warning "Method deprecated"

docs/dev/api/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ electron or nodejs APIs.
66
The extension UI API provides a way for the frontend to perform different actions
77
and communicate with the Docker Desktop dashboard or the underlying system.
88

9-
- [Backend](./backend.md)
9+
- [Extension Backend](./backend.md)
1010
- [Docker](./docker.md)
1111
- [Dashboard](./dashboard.md)
1212
- [Navigation](./dashboard-routes-navigation.md)

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ nav:
6363
- Build, test and install an extension: dev/cli/build-test-install-extension.md
6464
- UI API:
6565
- Overview: dev/api/overview.md
66-
- Backend: dev/api/backend.md
66+
- Extension Backend: dev/api/backend.md
6767
- Docker: dev/api/docker.md
6868
- Dashboard: dev/api/dashboard.md
6969
- Navigation: dev/api/dashboard-routes-navigation.md

0 commit comments

Comments
 (0)