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

Additional terminology entry for Web Object #856

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mlagally
Copy link
Contributor

@mlagally mlagally commented Oct 18, 2022

Additional terminology entry for Web Object, which is an entity with a network interface.


Preview | Diff

@mmccool
Copy link
Contributor

mmccool commented Oct 18, 2022

Is this to capture existing usage in the document? Also, how does it relate to other terms like Service and Virtual Thing? I assume the intention is to include services (since Directories are mentioned) but it would be good to be explicit. I'm not quite sure how this fits into the ontology or how it is different from (or a synonym for) other definitions we have. Using actual links to other defined terms (and using caps for them) would also be good.

Also, it should be noted that "network interface" is a little vague, since an entity could have a network interface (e.g. an ethernet jack and hardware) but not a network API (e.g. application-level protocol with defined endpoints) and could also be using a protocol like MQTT or OPC UA (or MODBUS-TCP if you wanted an outlier). I am personally fine with this term including non-HTTP protocols but I wanted to confirm that is the intended meaning. In particular, I would assume based on the wording and implied describability in TDs that non-RESTful protocols would be included. To tighten things a little bit we may at least want to say "network API" here instead.

Generally I am a little reluctant to add new content to the document at this point unless there is a VERY good reason.

@egekorkan
Copy link
Contributor

I second @mmccool 's comment. My reasons:

  • I do not understand why this is needed in the first place. More specifically, what issue is addressed?
  • Where did we agree that this is the term to describe this definition? Like @mmccool above, why is this different than a Servient?
  • It is not a good idea to have two terms like Web Thing and Web Object , that can even mean the same thing in some languages or contexts. This would confuse readers
  • Why is lint ignore added? Better to use a definition if it is defined. Why add a definition in the first place if it is not used at all?
  • The PR Additional terminology entry for Web Object #857 does this as well and that one is just merged without any discussion, review or gives any time to review? It is created 5h ago and merged 5h ago, giving 59 minutes to review in the best case.

@k-toumura
Copy link
Contributor

I've previously drawn the following diagram to help organize terms such as Thing and Consumer. I think this might be useful to clarify the meaning of "Web Object".
diagram
(https://github.com/w3c/wot-architecture/blob/main/proposals/wot-arch-terms.drawio.svg; you can edit it by https://app.diagrams.net/ )

Personally, I think it is better to postpone major architectural update to Arch2.0 as we are already in the process of preparing for CR....

@mlagally mlagally changed the title Update index.html Additional terminology entry for Web Object Oct 19, 2022
@mlagally
Copy link
Contributor Author

Motivation for inclusion of Web Object:

We have several components in the Web which are not things, i.e. cannot be described with a TD. We discussed for example that we cannot describe some consumers with a TD, so this is something like an abstract base class.

See also the diagram provided by @k-toumura: The discoverer and the consumer don't have TDs.

This is a only an additional entry in the infomative terminology section without any spec impact. It will be useful for the consumer description in the Profile.

@egekorkan
Copy link
Contributor

We have several components in the Web which are not things, i.e. cannot be described with a TD. We discussed for example that we cannot describe some consumers with a TD, so this is something like an abstract base class.

How is this different than a servient in this case?

@mlagally
Copy link
Contributor Author

@k-toumura

I've previously drawn the following diagram to help organize terms such as Thing and Consumer. I think this might be useful to clarify the meaning of "Web Object".
diagram
(https://github.com/w3c/wot-architecture/blob/main/proposals/wot-arch-terms.drawio.svg; you can edit it by https://app.diagrams.net/ )

This diagram is very useful and we should have included it into the spec in the terminology section. Perhaps we still should do that as an editorial update? The Terminology section is informative.

@mlagally
Copy link
Contributor Author

Arch call on Oct 27.
No consensus, agree to keep open and revisit. This is not blocking CR
If additional terminology is required in Profile, Profile should define it there.

<dfn class="lint-ignore">Web Object</dfn>
</dt>
<dd>An entity that has a network interface.
Examples include devices, directories, consumers and things.</dd>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since Web is all about HTTP, this could be refined.

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.

5 participants