w3c / w3c/wot-scripting-api

Handling pagination

Open
#310 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The latest specification of Thing Description of a TDD introduces pagination. Even if it used as a convenient way to return a set of TDs, it might as well be used as a return type of one Property or Action affordance. Currently, we could cover this use case using the streaming API. However, you can't really control pages from the streaming API ( you cannot seek a specific page).

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 reviewing the existing streaming API and how it represents sets of TDs, Property affordances, and Action affordances. Define how pagination and seeking a specific page should work for these cases, then document the required API behavior and validation criteria.

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.