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.

Sign up for GitHub

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

Jump to bottom

Init information about WoT relation types #1034

Merged
merged 5 commits into from
Feb 3, 2021
Merged

Init information about WoT relation types #1034

merged 5 commits into from
Feb 3, 2021

Conversation

sebastiankb
Copy link
Contributor

@sebastiankb sebastiankb commented Jan 18, 2021 •
edited by pr-preview bot
Loading

This PR introduces a new chapter in the TD spec about the relation types that are useful in the WoT context (also see eg. #918)

Preview | Diff

@sebastiankb
Copy link
Contributor Author

There is a list of requirements for the relation types. I tried to reuse existing definitions from IANA relation types as much as possible.

@sebastiankb sebastiankb mentioned this pull request Jan 18, 2021
Closed
@egekorkan
Copy link
Contributor

I think that this is a good start. Just one small thing in the examples: There is the mention of a "Drive" which I guess means a motor driver used in factories/automation. A more simple to understand Thing would be better for a wider audience

danielpeintner
danielpeintner reviewed Jan 19, 2021
View reviewed changes
index.html Outdated
</p>
<section id="links-relation-types-values">
<h2>Relation Values</h2>
<p>In the following a best praxis relation type table is introduced that is recommended to use within WoT <a>Thing Description</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

"best praxis relation" --> "best practise relation" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@sebastiankb
Copy link
Contributor Author

I think that this is a good start. Just one small thing in the examples: There is the mention of a "Drive" which I guess means a motor driver used in factories/automation. A more simple to understand Thing would be better for a wider audience

I updated the example + provide a collection example to provide basic idea of item and collection.

@sebastiankb sebastiankb changed the title init new chapter about WoT relation types Init new chapter about WoT relation types Jan 19, 2021
egekorkan
egekorkan reviewed Jan 19, 2021
View reviewed changes
Copy link
Contributor

@egekorkan egekorkan left a comment

Choose a reason for hiding this comment

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

Just put some comments regarding the use of engine/motor. Generally for electric motors the word motor is used from my experience

index.html Outdated
@@ -4739,7 +4739,7 @@ <h1>WoT Link Relation Types</h1>
</p>
<section id="links-relation-types-values">
<h2>Relation Values</h2>
<p>In the following a best praxis relation type table is introduced that is recommended to use within WoT <a>Thing Description</a>
<p>In the following a best practise relation type table is introduced that is recommended to use within WoT <a>Thing Description</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

practice

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

index.html Outdated
@@ -4853,8 +4853,8 @@ <h2>Examples</h2>

<p>A superordinate Thing can collect a group of Things and refer to them by using the <code>item</code> value:</p>

<pre class="example" title="A drive includes two engines.">
"title" : "Drive",
<pre class="example" title="An electric drive includes two engines.">
Copy link
Contributor

Choose a reason for hiding this comment

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

two electric motors

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

index.html Outdated
@@ -4870,6 +4870,22 @@ <h2>Examples</h2>
...
</pre>

<p>A Thing refers to a group in which it is collected with the <code>collection</code> value:</p>

<pre class="example" title="An electric engine is member of the electric drive collection.">
Copy link
Contributor

Choose a reason for hiding this comment

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

electric motor

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@sebastiankb
Copy link
Contributor Author

From today's TD call:

  • this kind of information should be normative
  • the table and its values should be introduced in Chapter 5 (Links)
  • examples should be provided in Chapter 6 (links) and Chapter 10 (Thing Model)
  • controlledBy and assembly should be introduced in the list (check existing definitions)
  • cardinality should be introduced in the table as well

@sebastiankb sebastiankb changed the title Init new chapter about WoT relation types WIP: Init new chapter about WoT relation types Jan 20, 2021
@sebastiankb sebastiankb mentioned this pull request Jan 22, 2021
Closed
@sebastiankb sebastiankb changed the title WIP: Init new chapter about WoT relation types Init new chapter about WoT relation types Jan 29, 2021
@sebastiankb
Copy link
Contributor Author

last commit addresses #1034 (comment)

assembly was not introduced since this is covers already by the collection value.

Ready to merge

@sebastiankb sebastiankb changed the title Init new chapter about WoT relation types Init information about WoT relation types Jan 29, 2021
@sebastiankb
Copy link
Contributor Author

From today's TD call:

  • we should clarify the definition about collection
  • collection seems more relevant for pointing to a directory or DB
  • we will merge this PR and continue the discussion about collection vs assembly
  • discovery TF will also provide some comments as issue

@sebastiankb sebastiankb merged commit 52a8390 into master Feb 3, 2021
@egekorkan egekorkan deleted the rel-types branch January 28, 2022 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielpeintner danielpeintner danielpeintner left review comments

@egekorkan egekorkan egekorkan left review comments

@benfrancis benfrancis Awaiting requested review from benfrancis

@mlagally mlagally Awaiting requested review from mlagally

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@sebastiankb @egekorkan @danielpeintner