The database for the searching on data models, properties and their descriptions has been expanded to allow filtering also by :
Additionally, it has been updated containing more than 11.000 items
Accessible from the front page in this widget (Structured check)
You can export the results
Now you can see the links to the specification in two languages, Spanish y French in the README.md of every data models. German and Japanese are in the queue.
See here an example
All the specifications (the text descriptions of the data model located in the /doc directory of each daat model) for the different domains and languages (currently French and Spanish besides English) have been updated to the new format. See an example in Spanish and French.
All of them are generated automatically from the json schema (which is the unique source of truth for the data model)
The contribution manual explains further details.
Raise an issue for any point you find in the new format.
If you want to check if a schema validates a payload through this API call
Call: https://smartdatamodels.org/extra/validate_payload.php
Parameters: (Mandatories)
Output: A json payload with these properties
on error
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.
