docs: remove retain from cmd/health/check examples - Githubissues

thin-edge / thin-edge.io

The open edge framework for lightweight IoT devices

https://thin-edge.io

Apache License 2.0

211 stars 55 forks source link

docs: remove retain from cmd/health/check examples #2828

Closed reubenmiller closed 2 months ago

reubenmiller commented 2 months ago

Proposed changes

Update examples showing how to request a health check from services to avoid using retained messages (as per our own guidelines).

Health checks is a notable exception to the rule "command status are published as retained messages". A health check is sent to the channel cmd/health/check of a service (or a device) as a non-retained request {}, triggering a health message response published on the status/health channel of the same service (or respectively the channels of all the service running on that device).

Types of changes

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
[x] Documentation Update (if none of the other choices apply)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

Checklist

[x] I have read the CONTRIBUTING doc
[x] I have signed the CLA (in all commits with git commit -s)
[ ] I ran cargo fmt as mentioned in CODING_GUIDELINES
[ ] I used cargo clippy as mentioned in CODING_GUIDELINES
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)

Further comments

github-actions[bot] commented 2 months ago

Robot Results

:white_check_mark: Passed	:x: Failed	:next_track_button: Skipped	Total	Pass %	:stopwatch: Duration
428	0	3	428	100	0s