w3c / w3c/wot-scripting-api

Add support for URI variables to `exploreDirectory` method

Open
#528 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-improvement discovery for next iteration use case
Dominant language
HTML
Stars
45
Forks
21
PR merge metrics
No merged PRs in 30d

Description

While dealing with the implementation of the exploreDirectory method, I noticed that the things property in the API specification Thing Model defines three uriVariables which are currently not accessible via our API (namely the query parameters offset, limit, and format).

Should we add these three as optional parameters to the method?

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 at the exploreDirectory method and compare its current parameters with the Thing Model directory API specification linked in the issue. Check how URI variables are exposed, then verify that optional offset, limit, and format parameters are accessible and that the existing behavior remains unchanged when they are omitted.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.