Skip to content

Commit

Permalink
docs: remove retain from cmd/health/check examples
Browse files Browse the repository at this point in the history
Signed-off-by: Reuben Miller <[email protected]>
  • Loading branch information
reubenmiller committed Apr 18, 2024
1 parent b3594ef commit 926169f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/src/references/mqtt-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -662,13 +662,13 @@ tedge mqtt pub -r te/device/main/service/tedge-agent/status/health '{
Services are responsible for updating their own health status by publishing to the above topic on any status changes. However, other clients can request the service to update its status by sending a health check command as shown below:

```sh te2mqtt formats=v1
tedge mqtt pub -r te/device/main/service/tedge-agent/cmd/health/check '{}'
tedge mqtt pub te/device/main/service/tedge-agent/cmd/health/check '{}'
```

Services are also expected to react to device-wide health check commands as well (where service and `<service_id>` segments are left blank):

```sh te2mqtt formats=v1
tedge mqtt pub -r te/device/main///cmd/health/check '{}'
tedge mqtt pub te/device/main///cmd/health/check '{}'
```

On receipt of the above command, all services on that device should respond with their health status.
Expand Down

0 comments on commit 926169f

Please sign in to comment.