Skip to content

Commit 8049b70

Browse files
committed
Tedge http reference documentation
Signed-off-by: Didier Wenzek <[email protected]>
1 parent bc697ff commit 8049b70

File tree

4 files changed

+27
-3
lines changed

4 files changed

+27
-3
lines changed

docs/src/operate/registration/register.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: 🚧 Entity management REST APIs
2+
title: Entity management REST APIs
33
tags: [Child-Device, Registration]
44
sidebar_position: 1
55
description: Register child devices and services with %%te%%
6-
draft: true
76
---
87

98
# REST APIs for Entity Management

docs/src/references/cli/tedge-upload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "tedge upload"
33
tags: [Reference, CLI]
4-
sidebar_position: 6
4+
sidebar_position: 7
55
---
66

77
# The tedge upload command

docs/src/references/cumulocity-proxy.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,16 @@ The proxy server currently forwards this response directly to the client, as wel
4545
Cumulocity.
4646
If there is an error connecting to Cumulocity to make the request, a plain text response with the status
4747
code `502 Bad Gateway` will be returned.
48+
49+
## Using tedge http
50+
51+
[`tedge http`](../references/cli/tedge-http.md) can be used to access Cumulocity from any child devices,
52+
provided [proper configuration](../references/cli/tedge-http.md#configuration).
53+
54+
For example, you can access the current tenant information
55+
from the machine running `tedge-mapper` as well as any child device:
56+
57+
```sh title="Interacting with Cumulocity"
58+
tedge http get /c8y/tenant/currentTenant
59+
```
60+

docs/src/references/file-transfer-service.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,15 @@ Once HTTPS is enabled for the file-transfer service, certificate-based authentic
4444
The directory containing the certificates that the agent will trust can be configured using `http.ca_path`,
4545
and the mapper as well as the child device agents can be configured to use a trusted certificate using the
4646
`http.client.auth.cert_file` and `http.client.auth.key_file` settings.
47+
48+
## Using tedge http
49+
50+
[`tedge http`](../references/cli/tedge-http.md) can be used to access the file transfer service from any child devices,
51+
provided [proper configuration](../references/cli/tedge-http.md#configuration).
52+
53+
54+
|Type| Command |
55+
|----|---------------------------------------------------------------------------------------|
56+
|Upload| `tedge http put tedge/file-transfer/{path}/{to}/{resource} --file /{path}/{to}/{file}` |
57+
|Download| `tedge http get /tedge/file-transfer/{path}/{to}/{resource} >/{path}/{to}/{file}` |
58+
|Delete| `tedge http delete /tedge/file-transfer/{path}/{to}/{resource}` |

0 commit comments

Comments
 (0)