telefonicaid / telefonicaid/iotagent-node-lib
doc: lack of detail in Device datamodel
Open
@mapedraza is already working on this.
Since Aug 22, 2023.
documentation
- Dominant language
- JavaScript
- Stars
- 62
- Forks
- 90
- Avg merge
- 2h 35m
- Merged PRs (30d)
- 1
Description
In https://github.com/telefonicaid/iotagent-node-lib/blob/master/doc/api.md#config-group-datamodel
- type should be detailed
- Description should be improved (e.g. "list" is ambiguous, it should be explained that it refers to a list of objects)
In https://github.com/telefonicaid/iotagent-node-lib/blob/master/doc/api.md#device-datamodel
- Description should be improved. It is not explained with fields can be used in the elements of such lists. Consider to use an extra section for that if needed
Side-note: why in config group we use eg. string as type but in device we use string as type? It should be the same style (I'd suggest just eg. string for simplicity)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.