w3c / w3c/wot-scripting-api

Discussion about read- write-/multipleproperties

Open
#219 17 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

for next iteration priority: high wait-for-td
Dominant language
HTML
Stars
45
Forks
21
PR merge metrics
No merged PRs in 30d

Description

In the Scripting API call we did have an interesting discussion about what does op readmultipleproperties mean. We did have the feeling that the TD spec is not super clear about that case. I tried to look into it and found the following para (last para in 5.3.1.1 Thing)

If not specified otherwise (e.g., through a TD Context Extension), the request data of the readmultipleproperties operation is an Array that contains the intended PropertyAffordances instance names, which is serialized to the content type specified by the Form instance.

This seems to match with what we have in https://w3c.github.io/wot-scripting-api/#the-readmultipleproperties-method. There needs to be a dedicated form with op being readmultipleproperties and one can specify an array of property names.
Does everybody agree?

In the case of writemultipleproperties it is the same I think.

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 by comparing the cited Thing Description section with the Scripting API readmultipleproperties method, then review the discussion about writemultipleproperties. Done requires resolving whether the stated request format and dedicated forms are correct and recording the agreed interpretation in the relevant specification text.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
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.