Skip to content

Commit

Permalink
Merge pull request #103 from gtardif/minor_backend_section_changes
Browse files Browse the repository at this point in the history
Minor backend section changes
  • Loading branch information
gtardif authored Mar 3, 2022
2 parents a60b99c + 1f00e97 commit 89cd128
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
12 changes: 8 additions & 4 deletions docs/dev/api/backend.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Communication with the backend
## Communication with the extension backend

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.

Expand All @@ -16,7 +16,7 @@ window.ddClient.extension.vm.service
Other methods for POST, UPDATE, DELETE, etc. are available, see [Service API Reference](reference/interfaces/http_service.HttpService.md#Methods)
### Deprecated backend communication
### Deprecated extension backend communication
!!! warning "Methods deprecated"
Expand Down Expand Up @@ -58,7 +58,7 @@ window.ddClient.backend
.then((value: any) => console.log(value));
```
## Running a command in the backend container
## Running a command in the extension backend container
Executes a command in the backend container.
Expand Down Expand Up @@ -88,7 +88,9 @@ await window.ddClient.extension.vm.cli.exec("ls", ["-l"], {
});
```
### Deprecated backend command execution
For more details, please refer to the [Extension VM API Reference](reference/interfaces/extension.ExtensionVM.md)
### Deprecated extension backend command execution
!!! warning "Method deprecated"
Expand Down Expand Up @@ -135,6 +137,8 @@ await window.ddClient.extension.host.cli.exec("kubectl", ["-h"], {
Streams the output of the command executed in the backend container or in the host.
For more details, please refer to the [Extension Host API Reference](reference/interfaces/extension.ExtensionHost.md)
### Deprecated invocation of extension binary
!!! warning "Method deprecated"
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ electron or nodejs APIs.
The extension UI API provides a way for the frontend to perform different actions
and communicate with the Docker Desktop dashboard or the underlying system.

- [Backend](./backend.md)
- [Extension Backend](./backend.md)
- [Docker](./docker.md)
- [Dashboard](./dashboard.md)
- [Navigation](./dashboard-routes-navigation.md)
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ nav:
- Build, test and install an extension: dev/cli/build-test-install-extension.md
- UI API:
- Overview: dev/api/overview.md
- Backend: dev/api/backend.md
- Extension Backend: dev/api/backend.md
- Docker: dev/api/docker.md
- Dashboard: dev/api/dashboard.md
- Navigation: dev/api/dashboard-routes-navigation.md
Expand Down

1 comment on commit 89cd128

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.