Link the API specification to the Thing Description version
Open
Nobody has claimed this yet.
for next iteration
priority: high
Spec-improvement
- Dominant language
- HTML
- Stars
- 45
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
The API document is closely related to the Thing Description document:
In conclusion, the WoT WG decided to explore the third option that closely follows the [WOT-TD] specification.
However, in the document, it is not clearly stated to which Thing Description version the API spec is referring to.
Other related issues:
#224
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the API document alongside the referenced Thing Description document and the [WOT-TD] specification, then inspect related issue #224 for context. Identify the Thing Description version the API specification targets, link to that version in the API document, and verify the reference is explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100