Author: maestro

No comments

Form for checking a schema submission

  By

The API call for checking a json schema submission before being accepted into the data models are already available here:

Now it can be also used through a form like this one in this other link.

Check it out below

    This form validates a submission of a data model and provides feedback in case is not compliant with the guidelines and the contribution manual and also whether the properties are already used in other data models



    TESTS TO PERFORM

    OUTPUT FORMAT

     

    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 an instant to redirect to the reults

     

     

    No comments

    Check a schema validates a payload

      By , , , , , , , , ,

    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
    No comments

    updated the contribution manual

      By , , , , , , , , ,

    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

    No comments

    Create automatically the specification of your data model

      By , , , , , , , , , ,

    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.