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

DataSchema type names alignments #89

Closed
danielpeintner opened this issue Feb 14, 2018 · 3 comments
Closed

DataSchema type names alignments #89

danielpeintner opened this issue Feb 14, 2018 · 3 comments

Comments

@danielpeintner
Copy link
Contributor

ThingPropertyInit has DataSchema type.

ThingActionInit has DataSchema inputDataDescription and DataSchema outputDataDescription.

ThingEventInit has DataSchema dataDescription

In general, this naming does not seem very much aligned and we might want to do some renaming.

ThingActionInit to DataSchema typeInput and DataSchema typeOutput and ThingEventInit to DataSchema type ?

Anyhow, given that in the TD (w3c/wot-thing-description#66) names are likely to change also I think it is reasonable to align before Prague...

@zolkis
Copy link
Contributor

zolkis commented Feb 14, 2018

The examples in the TD spec are not aligned with their own definitions. Let's fix naming first in the TD spec and Bindings.

Actions usually have arguments and return something. Keeping that semantics, in ThingActionInit I would rather use arguments instead of inputDataDescription, and return instead of outputDataDescription.

Events traditionally use data property. Therefore in ThingEventInit we should use data. That is general expectation from developers used with events.

A property usually has name and value. The value has a type. Therefore in ThingPropertyInit we could use type, valueType or simply schema.

All of the above are specified as schemas, represented by DataSchema which could be string or object (dictionary).

@mkovatsc
Copy link
Contributor

Best wait for outcome of naming discussion or participate in w3c/wot-binding-templates#13

@zolkis
Copy link
Contributor

zolkis commented Jun 8, 2018

Should be fixed by #113

@zolkis zolkis closed this as completed Jun 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants