thin-edge.io
thin-edge.io copied to clipboard
Issue #1197 Document events API for child devices
Proposed changes
Document events API for child devices
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
- [x] I have added necessary documentation (if appropriate)
This document says nothing about the SmartREST 105 and SmartREST 106 Cumulocity messages. Such a reference could be used to clarify the behavior of thin-edge when an event is send for a child device for the fist time.
This document says nothing about the SmartREST 105 and SmartREST 106 Cumulocity messages. Such a reference could be used to clarify the behavior of thin-edge when an event is send for a child device for the fist time.
Even though this was originally proposed in #1197, it was decided not to pre-populate the child id cache as it didn't offer any major benefits other than the trivial perf gain for the very first message. This decision was captured in this comment on that issue as well: https://github.com/thin-edge/thin-edge.io/issues/1197#issuecomment-1161542019
This document says nothing about the SmartREST 105 and SmartREST 106 Cumulocity messages. Such a reference could be used to clarify the behavior of thin-edge when an event is send for a child device for the fist time.
A consequence of ignoring what is declared on the cloud is that deleted child devices are unintendedly recreated.
Signed-off-by
line is missing in all commits.