Would be nice to have a json schema for each data model about data-models HOT 6 CLOSED

@LeonanCarvalho and @jmcanterafonseca ,

It really makes sense a DataModel Schema. In some way, this remembers me the Web Services Description Language (WSDL) - https://www.w3.org/TR/wsdl - WSDL is used to describe an Web Service in a machine readable format.
We are open to contribute to this initiative!

I would suggest follow guidelines defined under IETF to the schema (https://tools.ietf.org/id/draft-zyp-json-schema-04.html). There are related initiatives regarding JSON Schema (http://json-schema.org/). There is also a tool that can help the JSON Schema creation (http://jsonschema.net/)

from data-models.

thanks for this input. I think it would be great to have a JSON, machine readable description of each of the data models. That would eventually allow us to automatically generate the markdown documentation file associated to each data model.

Any contribution would be very welcome. For instance, you can start by contributing the example you have described in this issue.

from data-models.

Thank your for the appreciation.

I'll send a pull request and I'm open to discus this model with you. I'll include Professor @flaviosilva on this conversation, may he could help us to improve and review this schemas.
On this pull I'll send the schemas for Device, DeviceModel, WaterQualityObserved, Vehicle, VehicleModel.

from data-models.

thanks Leonan, but please use one pull request per entity type, that would
make it easier the review process

best

2016-10-31 14:21 GMT+01:00 José Leonan S. Carvalho <[email protected]

:

Thank your for the appreciation.

I'll send a pull request and I'm open to discus this model with you. I'll
include Professor @flaviosilva https://github.com/flaviosilva on this
conversation, may he could help us to improve and review this schemas.
On this pull I'll send the schemas for Device, DeviceModel,
WaterQualityObserved, Vehicle, VehicleModel.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#76 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAqZ_lJulfMaebdXK8vHtY1EX_h_onHXks5q5es9gaJpZM4KgE9O
.

from data-models.

That's the point! Thanks!

The guidelines defined under IETF should be enough to clarify some questions, like how to represent normative references of attributes.

I would like to read it deep this requirements to better understand and then adjust the models suggested on #81 , #82 , #83 , #84 and #85 pull requests.

On a second moment it will be great develop a tool to generate the structure and the docs based on this schema.

from data-models.

closed as dup of #151

from data-models.