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

TD Processor definition contain assertions #1434

Closed
egekorkan opened this issue Mar 14, 2022 · 0 comments · Fixed by #1575
Closed

TD Processor definition contain assertions #1434

egekorkan opened this issue Mar 14, 2022 · 0 comments · Fixed by #1575
Labels
V1.1 should be resolved in v1.1

Comments

@egekorkan
Copy link
Contributor

The definition for the TD Processor is currently:

  • A system that can serialize some internal representation of a Thing Description in a given format and/or deserialize it from that format. A TD Processor must detect semantically inconsistent Thing Descriptions, that is, Thing Descriptions that cannot satisfy constraints on the Instance Relation of the Thing class. For that purpose, a TD Processor may compute forms of Thing Descriptions in which all possible Default Values are assigned. A TD Processoris typically a sub-system of a WoT Runtime. Implementations of a TD Processor may be a TD producer only (able to serialize to TD Documents) or a TD consumer only (able to deserialize from TD Documents).

Even though this is purely a definition, it contains 3 sentence with assertion-like meaning. This is problematic because:

  • I am pretty sure that definitions should not contain assertions
  • If they can contain, they should use the span and RFC keywords, otherwise they are not picked up testing tools and possibly implementors.
  • We do not see this kind of sentences as the working group. This text is very assertive on what a consumer should do, i.e. it says that a processor should detect invalid TDs. We have written a whole validation chapter but it does not exactly correlate perfectly with this definition.

In my opinion, these 3 sentences should be removed from the definition and placed elsewhere.

@egekorkan egekorkan changed the title TD Processor definition contain assertion TD Processor definition contain assertions Mar 14, 2022
@egekorkan egekorkan added the V1.1 should be resolved in v1.1 label Jun 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V1.1 should be resolved in v1.1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant