Wot-thing-description: Refer to developer documentation from a TD

Created on 18 Jun 2020  路  5Comments  路  Source: w3c/wot-thing-description

The TD should contain a field to refer to developer documentation.

PR available

Most helpful comment

Web linking container should be used for that purpose:

...
"links": [{
    "rel": "documentation",
    "href": "https://example.com/howTo",
    "type": "application/pdf"
}]
...

The 'rel' type value does not yet exist, but this is an issue that is addressed in the new charter anyway.

All 5 comments

Web linking container should be used for that purpose:

...
"links": [{
    "rel": "documentation",
    "href": "https://example.com/howTo",
    "type": "application/pdf"
}]
...

The 'rel' type value does not yet exist, but this is an issue that is addressed in the new charter anyway.

I like this approach, it would be nice to have it in an example.
@sebastiankb:
we should define this "documentation" relationship type in the 1.1 spec.

I started to work on the topic about relation types and created a PR for the TD spec #1034. I would be happy to receive some feedback.

issue is addressed in the latest draft

Was this page helpful?
0 / 5 - 0 ratings