Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: lack of detail in Device datamodel #1409

Open
Tracked by #1329
fgalan opened this issue Aug 2, 2023 · 2 comments
Open
Tracked by #1329

doc: lack of detail in Device datamodel #1409

fgalan opened this issue Aug 2, 2023 · 2 comments
Assignees

Comments

@fgalan
Copy link
Member

fgalan commented Aug 2, 2023

In https://github.com/telefonicaid/iotagent-node-lib/blob/master/doc/api.md#config-group-datamodel

imagen

  • 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

imagen

  • 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)

@PradyumnAgrawal05
Copy link

Hello @fgalan . I am working on it.

@mapedraza
Copy link
Collaborator

@Pradyumn-NEC Please take another issue. Documentation issues should not be taken now. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants