Alpha version for drafting a data model

In case you are not an expert for creating a JSON schema (one of the elements of a data model)
On this page, you have a spreadsheet for helping with the first steps.


1.- Fill the spreadsheet with the names of the properties for your model

2.- fill the NGSI type (Property, Relationship or Geoproperty)

3.- In case of property, fill the data type (array and object types are currently not completely supported)

4.- Fill in the description

5.- Click the button, the page will reload

6.- voila! you have your json schema below the spreadsheet, just copy and paste into your favourite editor.

The python code for it is also made public in the utils directory in the data models repo.

New Data model TouristTrip

The new Subject of dataModel.TourismDestinations, inside the SmartDestination domain has released 1 new data model:

  • TouristTrip : A tourist trip. A created itinerary of visits to one or more places of interest (TouristAttraction/TouristDestination) often linked by a similar theme, geographic area, or interest to a particular touristType. The UNWTO defines tourism trip as the Trip taken by visitors. This data model is based on standard UNE178503. It is also compatible with schema.org. Some of the elements of schema.org has been adapted in this file https://smart-data-models.github.io/data-models/schema-org.json. Minor adjustments were necessary to keep compatibility with schema.org.

Instructions to be listed as a data model adopter of Smart Data Models

It has been updated the format of the list of adopters of the data models (formerly were CURRENT-ADOPTERS.md markdown files), now in it is rename into ADOPTERS.yaml based on this yaml template which allows an automatic processing. (Further announcements could be included in a future).

Further instructions in the page Data Models Adopters how to located in the menu option Data models -> Data Models Adopters How to

New Subject TouristDestination at Smart Destinations domain and data models Event and Tourist Destination

New Subject, dataModel.TourismDestinations for allocating data models related to touristic destinations.

It is located in the Smart Destinations domain repository.

Event is based on the examples provided for the semantic standard UNE 178503 and schema.org.

TouristDestination is also based on this standard and UNE178503.

Schema and examples already available, specification and other documents will be available as soon as the general scripts run on this repo.

 

Improved the database of properties

The database for the searching on data models, properties and their descriptions has been expanded to allow filtering also by :

  • NGSI type (one of Property, Relationship or Geoproperty)
  • data type (string, number, boolean, array, object, etc)

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

Specifications in languages in the readme of the data models

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 specifications updated

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.

 

 

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)

Example: https://smartdatamodels.org/extra/validate_payload.php?payloadUrl=https://raw.githubusercontent.com/smart-data-models/dataModel.Battery/master/Battery/examples/example.json&schemaUrl=https://raw.githubusercontent.com/smart-data-models/dataModel.Battery/master/Battery/schema.json

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

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

Example: https://smartdatamodels.org/extra/create_spec.php?dataModel=Airport&schemaUrl=https://raw.githubusercontent.com/smart-data-models/incubated/master/Aeronautics/Airport/schema.json&examplesUrl=https://raw.githubusercontent.com/smart-data-models/incubated/master/Aeronautics/Airport/examples/&notesUrl=%22%22&mail=alberto.abella@fiware.org

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.