Data Models Contribution API

TEST 1: Check if your candidate schema is properly documented

The schemas to be accepted need to include a description for every property

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

Example: https://smartdatamodels.org/extra/check_schema.php?schemaUrl=https://raw.githubusercontent.com/smart-data-models/dataModel.Building/master/Building/schema.json&mail=alberto.abella@fiware.org&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 of the property reach 15 chars.
  • text: Text. complementary information about the documentation (it could be either incomplete or non existing)

If you prefer a classic form

    This form validates a submission of a data model and provides feedback in case is not compliant with the guidelines and the contribution manual

    TESTS TO PERFORM

     




    By using this form you agree with the storage and handling of your data by this website.

    After clicking it will appear a message confirming the submission

    It will take a couple of minutes to redirect to the feedback on a specific page depending on the text selected.

    Thanks for being patient

    Comments are closed.