search

WebThingsIO / api

Web Thing API Specification
http://iot.mozilla.org/wot/
Other
164 stars 25 forks source link

Add human friendly `name` to property, action and event objects #81

Closed benfrancis closed 6 years ago

benfrancis commented 6 years ago

As a developer I want to specify a human friendly name for a property, action or event which can be displayed in UI (this is in addition to the machine friendly id used as the object key).

benfrancis commented 6 years ago

Currently the W3C specification has conflicting information over whether this should be called "name" or "label".

stpeter commented 6 years ago

Currently https://www.w3.org/TR/2018/WD-wot-thing-description-20180405/ has "name": "MyLampThing" but perhaps it's label in other places.

You might want to read https://tools.ietf.org/html/rfc8266 on nicknames for things. It can get complicated. ;-)

benfrancis commented 6 years ago

Currently https://www.w3.org/TR/2018/WD-wot-thing-description-20180405/ has "name": "MyLampThing" but perhaps it's label in other places.

Yes it's inconsistent. I've filed a bug.

You might want to read https://tools.ietf.org/html/rfc8266 on nicknames for things. It can get complicated. ;-)

Oh my!

benfrancis commented 6 years ago

Looks like this has now stabilised in the latest Editor's Draft and https://github.com/w3c/wot-thing-description/issues/123 is now closed.

Top level Thing has a "name" and interactions (properties, actions and events) have "label"s.

benfrancis commented 6 years ago

Correction: Events don't appear to have labels.