w3c / w3c/wot-scripting-api

Consuming composited Thing Description

Open
#363 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority: low use case
Dominant language
HTML
Stars
45
Forks
21
PR merge metrics
No merged PRs in 30d

Description

In the current version of the Thing Description Editor's Draft a composition feature for Thing Models has been introduced. Here, subordinate TMs are referred to in the links container using the link relation tm:subthing. If a composited Thing Model is converted into a Thing Description, these links and their associated subthings are converted as well, as displayed in this example.

How should a consumer deal with such a composited Thing Description? Should all linked Thing Description be retrieved and consumed as well if the "top level" TD is consumed? Or should the TDs of subthings be consumed in a separate step?

Contributor guide

Open the contributing guide

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

Start with the Thing Description Editor's Draft's Thing Model composition section and example 57, then review the issue's linked discussion about consuming subordinate Thing Descriptions. Done means reaching and documenting an agreed rule for whether linked subthings are consumed with the top-level description or separately.

Written by the indexing model from the issue text.

Assessment

Domain
api
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.