Tedge http reference documentation

Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
thin-edge · Feb 10, 2025 · 8049b70 · 8049b70
1 parent bc697ff
commit 8049b70
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/docs/src/operate/registration/register.md b/docs/src/operate/registration/register.md
@@ -1,9 +1,8 @@
 ---
-title: 🚧 Entity management REST APIs
+title: Entity management REST APIs
 tags: [Child-Device, Registration]
 sidebar_position: 1
 description: Register child devices and services with %%te%%
-draft: true
 ---
 
 # REST APIs for Entity Management

diff --git a/docs/src/references/cli/tedge-upload.md b/docs/src/references/cli/tedge-upload.md
@@ -1,7 +1,7 @@
 ---
 title: "tedge upload"
 tags: [Reference, CLI]
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # The tedge upload command

diff --git a/docs/src/references/cumulocity-proxy.md b/docs/src/references/cumulocity-proxy.md
@@ -45,3 +45,16 @@ The proxy server currently forwards this response directly to the client, as wel
 Cumulocity.
 If there is an error connecting to Cumulocity to make the request, a plain text response with the status
 code `502 Bad Gateway` will be returned.
+
+## Using tedge http
+
+[`tedge http`](../references/cli/tedge-http.md) can be used to access Cumulocity from any child devices,
+provided [proper configuration](../references/cli/tedge-http.md#configuration).
+
+For example, you can access the current tenant information
+from the machine running `tedge-mapper` as well as any child device:
+
+```sh title="Interacting with Cumulocity"
+   tedge http get /c8y/tenant/currentTenant
+```
+
diff --git a/docs/src/references/file-transfer-service.md b/docs/src/references/file-transfer-service.md
@@ -44,3 +44,15 @@ Once HTTPS is enabled for the file-transfer service, certificate-based authentic
 The directory containing the certificates that the agent will trust can be configured using `http.ca_path`,
 and the mapper as well as the child device agents can be configured to use a trusted certificate using the
 `http.client.auth.cert_file` and `http.client.auth.key_file` settings.
+
+## Using tedge http
+
+[`tedge http`](../references/cli/tedge-http.md) can be used to access the file transfer service from any child devices,
+provided [proper configuration](../references/cli/tedge-http.md#configuration).
+
+
+|Type| Command                                                                               |
+|----|---------------------------------------------------------------------------------------|
+|Upload| `tedge http put tedge/file-transfer/{path}/{to}/{resource} --file /{path}/{to}/{file}` |
+|Download| `tedge http get /tedge/file-transfer/{path}/{to}/{resource} >/{path}/{to}/{file}`     |
+|Delete| `tedge http delete /tedge/file-transfer/{path}/{to}/{resource}`                       |