The contribution manual (link in the upper menu of main page) is updated due to the change in the approach for documenting the data models.
Main changes:
See the rest of changes in the link
The new version of the smart data models specification is on progress (most of the /doc directories of the data models have a version). If you want to check how this would look like you can have through this API call
Call: https://smartdatamodels.org/extra/create_spec.php
Parameters: (Mandatories)
Output: A markdown text that although the HTML visualization is faulty, the source code of the page can be pasted in any markdown viewer (optimized for github) and you see will see something like this.
We are on the transition to having all the data models compliant.
The schemas to be accepted in the Smart Data Model initiative need to include a description for every property. In order to review your data models before submission, it should pass this test.
Call: https://smartdatamodels.org/extra/check_schema.php
Parameters: (Mandatories)
Output: A json payload with the list with of properties of the data model including those referenced through $ref and its status of documentation in the schema.
In order to be accepted all the properties have to include a relevant description, and therefore need to have both parameters x-ngsi and documented to True for all the properties.
We are on the transition to having all the data models compliant.
Most of the data models have a new file into its /doc directory name spec_FR.md. It contains a specification generated automatically based on the schema.json with all its texts translated into French. (With the deepL tool, so you can expect some ‘incorrect’ translated elements).
The official spec remains to be the spec.md file. However in coming days, the format, but not the name of this spec will change when the version named spec_EN-US.md will become official and it will replace the contents of spec.md.
Independently of what is happening the official version will always be spec.md.
Other languages, possibly German, Japanese and eventually Chinese are on the queue.
Most of the data models have a new file into its /doc directory name spec_ES.md. It contains a specification generated automatically based on the schema.json with all its texts translated into Spanish. (With the deepL tool, so you can expect some ‘incorrect’ translated elements.
The official spec remains to be the spec.md file. However in coming days the format, but not the name of this spec will change when the version named spec_EN-US.md will become official and it will replace the contents of spec.md.
Independently of what is happening the official version will be always spec.md.
There is a new specification (in draft mode) in each directory (most of them) of the data models. It has the name spec_EN-US.md and it is drafting the new specification format for all the data models.
Currently, this format is under design and feedback is welcomed in this form, option feedback on the new specification.
You’ll notice that there is a new file in the directory of the data models named new_model.yaml
This file is a temporary version of model.yaml till we replace model.yaml (formerly created manually) for this new_model.yaml which is automatically generated from the json schema.
some other changes will be announced soon.
The properties of the building data models have been documented to allow the schema-generated specs.
In order to:
It has been decided that the description of the properties of the data models will be included in the schemas defining the data models (or those linked through $ref). so during next days, you will see minor changes in the schema.json of every data model in the initiative.
And although it will be announced previously all the spec.md will be replaced by an automatically generated (based on the info). See an example here. Design could be modified so any suggestion will be assessed and eventually implemented.
Customization will be possible through a new file named notes.yaml
This is taking most of our resources and impact on our bandwidth t provide answers to the PR, but we expect that this will reduce our workload significantly so we will be more agile after this change.
Thanks to user dvillalbamota has extended the data model of OffStreetParking to include two new properties and to make occupancy a percentage.
The schema.json has been updated accordingly and the examples.
