Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding terminology "WoT Profile" #865

Merged
merged 3 commits into from
Oct 27, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -699,6 +699,13 @@ <h1>Terminology</h1>
</dt>
<dd>An entity that can create WoT Thing Descriptions
for a specific Thing.</dd>
<dt>
<dfn>Profile</dfn>
</dt>
<dd>A technical specification which provides a set of assertions such that any <a>Consumer</a>
Copy link
Contributor

@sebastiankb sebastiankb Oct 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two comments here:

  • do we need another definition what "out-of-the-box" mean?
  • I think, the definition can be more clear that the Profile is a subset of the TD specification by providing additional assertions.

Proposal: A technical specification that is a subset of the Thing Description specification which provides additional set of restrictive assertions such that any Consumer which conforms with the those assertions is out-of-the-box interoperable with any Thing which also conforms with those assertions.

Copy link
Member

@benfrancis benfrancis Oct 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sebastiankb What does it mean to be a subset of a specification?

A profile is a collection of assertions which are neither a subset nor a superset of the assertions in the Thing Description specification, they are a separate collection of assertions with may define additional constraints and assumptions for conformant Consumers and Things.

I suspect what you're trying to say is that a Thing Description conforming to a profile can only use a subset of the features defined in the Thing Description specification, but that isn't really an accurate description either. A profile may define a subset of TD features (such as security schemes, protocol bindings, and semantic contexts) which a conformant Consumer must support, but it may also define additional assumptions (such as protocol binding defaults), some of which can't even be described declaratively in a Thing Description. That could be described as a superset of the features described in the TD specification.

This current definition of a profile has already been reviewed and landed in the WoT Profile specification, so whatever lands here will need to replace or be consistent with that definition. I prefer the current definition.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that I've started a discussion about a "Profile Mechanism 2.0" which could be much more rigidly defined, but that is a different approach to profiles than is taken in the current specification.

which conforms with the those assertions is out-of-the-box interoperable with any <a>Thing</a>
which also conforms with those assertions.
</dd>
<dt>
<dfn>Property</dfn>
</dt>
Expand Down Expand Up @@ -896,6 +903,10 @@ <h1>Terminology</h1>
</dt>
<dd>The network-facing interface of a Thing
that is described by a WoT Thing Description.</dd>
<dt>
<dfn>WoT Profile</dfn>
</dt>
<dd>Synonym for <a>Profile</a></dd>
<dt>
<dfn>WoT Runtime</dfn>
</dt>
Expand Down Expand Up @@ -2925,7 +2936,7 @@ <h2>Thing Model</h2>
<section id="wot-profiles">
<h3>Profiles</h3>
<p>
The WoT Profile Specification [[!WOT-PROFILE]] defines Profiles,
The <a>WoT Profile</a> Specification [[!WOT-PROFILE]] defines Profiles,
that enable <em>out of the box interoperability</em> among things
and devices. Out of the box interoperability implies,
that devices can be integrated into various application
Expand Down