w3c / w3c/wot-scripting-api

Directory - How to find things around me?

Open
#321 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

At the moment the discovery describes its interactions with the means of a TD (see https://github.com/w3c/wot-discovery/blob/main/directory.td.json)
e.g., it offers properties for "retrieveTD", "retrieveTDs", "searchJSONPath", "searchXPath", .. and some other actions/events to interact with a directory.

In the scripting API we used to have the following DiscoveryMethod enumeration (see https://www.w3.org/TR/wot-scripting-api/#the-discoverymethod-enumeration)

  • "any"
  • "local"
  • "directory" and
  • "multicast"

and we changed it to the following list (see https://w3c.github.io/wot-scripting-api/#the-discoverymethod-enumeration)

  • "direct" and
  • "directory"

The more I think about these facts and changes I wonder why we actually need a WoT Discovery conformance class.

For developers there is no real need for doings so IF I can only contact a TD/Thing directly or talk to a directory . One could consume the directory TD and act upon this TD.
OR
directly connect a Thing and retrieve the TD.

What we totally miss now is the case of a runtime that can scan for example the current network and find things around me. The directory does not do that for you. How can I fulfill this use-case?

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

Read directory.td.json and the Scripting API's DiscoveryMethod and discover-method sections linked in the issue. Compare the direct and directory models with the network-scanning use case, then determine whether a new discovery behavior or conformance requirement is needed. Done means the expected runtime behavior and API or specification changes are agreed.

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.