Bugs found in doc/howto.md and README.md

Open Beginner friendly
#541 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start by reviewing doc/howto.md and README.md, especially the API actions section. Verify the middleware activation instruction, the getDevice reference at manageULRequest, and the duplicated t object id in the device-registration JSON; done means all three documentation examples are accurate.

Written by the indexing model from the issue text.

Description

bug

  • This middleware must be added when activating the agent:

    iotAgentLib.addUpdateMiddleware(iotAgentLib.dataPlugins.attributeAlias.update);

  • Replace getDevice with retrieveDevice at manageULRequest.

  • Json payload for device registration example is wrong in README.md, "API actions" section: t object id appears twice when showing how to post a new device.

Dominant language
JavaScript
Stars
62
Forks
90
Avg merge
2h 35m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from telefonicaid/iotagent-node-lib

All issues in telefonicaid/iotagent-node-lib

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.