In the process of converting repositories to the new format, the repo dataModel.Agrifood is being converted.
It means:
- json schema has already documented every property
- The new specs in EN-US, FR and ES are available
No comments
Author: maestro
Check a schema validates a payload
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)
- payloadUrl: The url of the payload in RAW version
- schemaUrl: The link to the RAW version of the json schema (see example)
Output: A json payload with these properties
- result: Boolean. if the schema validates the payload.
- time: time stamp in ISO 8601 (CET) of the validation
- payloadUrl: The url of the payload in RAW version submitted
- schemaUrl: The link to the RAW version of the json schema submitted
on error
- cause: The description of the cause for the rejection to the validation
Repo dataModel.Weather updated
In the process of converting repositories to the new format, the repo dataModel.Weather is being converted.
It means:
- json schema has already documented every property
- The new specs in EN-US, FR and ES are available
Repo dataModel.PointOfinterest updated
In the process of converting repositories to the new format, the repo dataModel.PointOfInterestr is being converted.
It means:
- json schema has already documented every property
- The new specs in EN-US, FR and ES are available
repo dataModel.User updated
In the process of converting repositories to the new format, the repo dataModel.User is being converted.
It means:
- json schema has already documented every property
- The new specs in EN-US, FR and ES are available
repo datamodel.Device updated
In the process of converting repositories to the new format, the repo dataModel.device is being converted.
It means:
- json schema has already documented every property
- The new specs in EN-US, FR and ES are available
updated the contribution manual
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:
- Properties’ definitions are now included as an attribute in the json schema
- The specification is generated automatically based on the json schema
- Json schema has to pass a test to be approved.
See the rest of changes in the link
Create automatically the specification of your data model
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)
- dataModel: The name of the entity for the specification
- schemaUrl: The link to the RAW version of the json schema (see example)
- examplesUrl: the url of where the 4 examples required for a data model are available (named
- notesUrl: The url to the yaml for the customization paragraphs (notesHeader, after the title, notesMiddle, after properties’ list and notesFooter by the end)
- mail:Â a valid mail of yours
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.
Data Models Contribution API
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)
- schemaUrl: The link to the RAW version of the schema (see example)
- mail: your mail
- test: 1
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.
- x-ngsi: Boolean. Describes if the description contains property, relationship or geoproperty in the description.
- x-ngsi_text: Text. Further explanations about x-ngsi value.
- documented: Boolean. If the description is complete enough for its use.
- text: Text. complementary information about the documentation (It could be either incomplete or non-existing)
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.
French translation of data models available
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.
Slack channel
Validate a payload with a data model