telefonicaid / telefonicaid/iotagent-node-lib

timesinstant setting should allow distinguish between attribute and metadata TimeInstant

Open
#935 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently, we have a timeinstant boolean setting to include TimeInstant information or not in entities updates on the CB.

This setting can be configured at different levels (IOTA-wide, service or device) but it always affects to both the TimeInstant attribute and TimeInstant metadata. In other words, or both TimeInstant attribute and metadata are included or none of them is included, but mixed cases (e.g. include the TimeInstant attribute but not the TimeInstant metadata) are not possible.

So, some ideas:

  • "Split" the setting semantics in two. A new setting can be used to control metadatas (e.g. timeinstantMd), reducing the scope of existing timeinstant to the attribute.
  • Keep timeinstant field at root level in the JSON to mean the attribute, use a separate timeinstant field in the attribute mapping items to mean the specific metadata for that attribute. This is more flexible than the other in some cases, but in needs repeat timeinstant in the provision for each attribute.
  • Combine both. Somehow :)

(A small backward compatibility break would take place if we redefine timesinstant semantic, but it is not a widely used setting)

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.

Research direction

No file, test, or entry point is named. First locate the timeinstant setting and its handling, then resolve which proposed semantics to implement; done means attribute and metadata inclusion can be controlled as specified without leaving the compatibility behavior ambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.