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

Adding terminology "WoT Profile" #865

merged 3 commits into from
Oct 27, 2022

Conversation

mlagally
Copy link
Contributor

@mlagally mlagally commented Oct 25, 2022

Implement the proposal from TD issue #1719


Preview | Diff

Terminology entries for "WoT Profile" and "Profile"
<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.

@mmccool
Copy link
Contributor

mmccool commented Oct 27, 2022

I agree with Sebastian that we should keep the definition simple and not add extra embedded definitions. In fact I would not "guarantee" oobi because it's difficult to prove. The INTENT to improve it is enough. May I suggest:

WoT Profile: A named subset of Thing Descriptions defined by a set of assertions. The intent of a profile is to improve interoperability between Consumers and Things whose Thing Descriptions conform with those assertions.

@benfrancis
Copy link
Member

@mmccool Please see my comment at #865 (comment)

@mlagally mlagally merged commit 8cdbb9e into main Oct 27, 2022
@mlagally
Copy link
Contributor Author

Arch call on Oct 27th:
Unanimous Consensus

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants