WIP: Provide example in the new introduction section #334
Conversation
| <a href="#simple-profile-td-sample">Example 1</a> shows a <a>Thing Description</a> | ||
| instance that follows the <a>HTTP Basic Profile</a> as described in this | ||
| sepecification. |
There was a problem hiding this comment.
I would suggest describing this as "a Thing Description of a Web Thing which follows the HTTP Basic Profile", since it's really the Web Thing that follows the profile, not just the Thing Description.
There was a problem hiding this comment.
sepecification -> specification
| "@context": "https://www.w3.org/2022/wot/td/v1.1", | ||
| "id": "urn:uuid:0804d572-cce8-422a-bb7c-4212fcd56f06", | ||
| "profile": "https://www.w3.org/2022/wot/profile/http-basic/v1", | ||
| "title": "MyHTTPBasicProfileLampThing", |
There was a problem hiding this comment.
Title is meant to be a human readable string, so I would suggest adding spaces in the text.
| }, | ||
| "security": "basic_sc", | ||
| "properties": { | ||
| "status": { |
There was a problem hiding this comment.
Nit: Status is a bad name for a property. Any property could be described as being the Thing's status.
| }</pre> | ||
| </aside> | ||
| <p> | ||
| This <a>Thing Description</a> uses the <code>profile</code> term to signalize that the associated <a>Thing</a> |
| </aside> | ||
| <p> | ||
| This <a>Thing Description</a> uses the <code>profile</code> term to signalize that the associated <a>Thing</a> | ||
| supports the <a>HTTP Basic Profile</a>. As a security scheme, this example enforces authentication before access |
There was a problem hiding this comment.
"No matching definition" for "HTTP Basic Profile", need to add href="#http-basic-profile.
|
@sebastiankb Can you please rebase and resolve the merge conflict? |
<this PR is wip; please do not merge>
This PR takes the introduction text from @benfrancis and extended it with an example section to give the reader an easy-to-understand example of what a profile-based TD looks like.
Preview | Diff