{"id":322,"date":"2020-04-28T09:19:58","date_gmt":"2020-04-28T09:19:58","guid":{"rendered":"http:\/\/data-models.fiware.org\/?page_id=322"},"modified":"2020-04-28T09:21:47","modified_gmt":"2020-04-28T09:21:47","slug":"how-to-document-a-data-model","status":"publish","type":"page","link":"https:\/\/smartdatamodels.org\/index.php\/how-to-document-a-data-model\/","title":{"rendered":"How to document a data model"},"content":{"rendered":"<p>This is a provisional version for documenting a data model.<br \/>\npending to be applied to every data model respository.<br \/>\n<iframe loading=\"lazy\" src=\"https:\/\/docs.google.com\/presentation\/d\/17n_1xSly8NP4ElTD_6GBbtUjMZpIwt1JoyClrpO5GGw\/embed?start=false&amp;loop=false&amp;delayms=3000\" width=\"1280\" height=\"749\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><span style=\"display: inline-block; width: 0px; overflow: hidden; line-height: 0;\" data-mce-type=\"bookmark\" class=\"mce_SELRES_start\">\ufeff<\/span><\/iframe><\/p>\n","protected":false},"excerpt":{"rendered":"<p>This is a provisional version for documenting a data model. pending to be applied to every data model respository. \ufeff <a class=\"continue-reading-link\" href=\"https:\/\/smartdatamodels.org\/index.php\/how-to-document-a-data-model\/\">More&#8230;<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"class_list":["post-322","page","type-page","status-publish","hentry"],"jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":2201,"url":"https:\/\/smartdatamodels.org\/index.php\/generate-examples-of-ngsi-payloads-compliant-with-a-data-model\/","url_meta":{"origin":322,"position":0},"title":"Generate examples of NGSI payloads compliant with a data model","author":"maestro","date":"28\/04\/2021","format":false,"excerpt":"NGSI-LD normalized format NGSI-LD keyvalues format NGSIv2 normalized format (pending) NGSIv2 keyvalues format (pending)","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":909,"url":"https:\/\/smartdatamodels.org\/index.php\/create-automatically-the-specification-of-your-data-model\/","url_meta":{"origin":322,"position":1},"title":"Create automatically the specification of your data model","author":"maestro","date":"02\/12\/2020","format":false,"excerpt":"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\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":8287,"url":"https:\/\/smartdatamodels.org\/index.php\/pysmatdatamodels-documentation\/","url_meta":{"origin":322,"position":2},"title":"pysmartdatamodels documentation","author":"maestro","date":"10\/02\/2023","format":false,"excerpt":"1- Load all datamodels in a dict like the official list. Function load_all_datamodels() Returns a dict with all data models with this object structure - repoName: The name of the subject - repoLink: the link to the repository of the subject - dataModels: An array with all the datamodels of\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":10260,"url":"https:\/\/smartdatamodels.org\/index.php\/metadata-of-the-data-models-catalog-available\/","url_meta":{"origin":322,"position":3},"title":"Metadata of the data models catalog available","author":"maestro","date":"01\/02\/2024","format":false,"excerpt":"In this link you have all metadata of the catalogue available as a json file. It includes: subject data model version of the data model modelTags title url to $id of the schema description of the data model required attributes yamlUrl link to the yaml version of the schema jsonSchemaUrl\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":1829,"url":"https:\/\/smartdatamodels.org\/index.php\/generate-a-ngsi-ld-payload-based-on-a-smart-data-model\/","url_meta":{"origin":322,"position":4},"title":"Generate a NGSI-LD normalized payload based on a Smart Data Model","author":"maestro","date":"02\/03\/2021","format":false,"excerpt":"This is an alpha version (so you can expect errors and not being complete). Use it at your own risk. Please report them at info@smartdatamodels.org Call: https:\/\/smartdatamodels.org\/extra\/ngsi-ld_generator.php Parameters: (Mandatories) schemaUrl: The link to the RAW version of the json schema (see example) email: your email Example: https:\/\/smartdatamodels.org\/extra\/ngsi-ld_generator.php?schemaUrl=https:\/\/raw.githubusercontent.com\/smart-data-models\/dataModel.Streetlighting\/f56f5a7933ab05d7fce1d5adc0847f25a099cdb4\/StreetlightModel\/schema.json&email=alberto.abella@fiware.org Use any data\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":2199,"url":"https:\/\/smartdatamodels.org\/index.php\/generate-a-ngsi-ld-keyvalues-payload-compliant-with-a-data-model\/","url_meta":{"origin":322,"position":5},"title":"Generate a NGSI-LD keyvalues payload compliant with a data model","author":"maestro","date":"28\/04\/2021","format":false,"excerpt":"This is an alpha version (so you can expect errors and not being complete). Use it at your own risk. Please report them at info@smartdatamodels.org Call: https:\/\/smartdatamodels.org\/extra\/ngsi-ld_generator_keyvalues_v0.95.php Parameters: (Mandatories) schemaUrl: The link to the RAW version of the json schema (see example) email: your email Example: https:\/\/smartdatamodels.org\/extra\/ngsi-ld_generator_keyvalues_v0.95.php?schemaUrl=https:\/\/raw.githubusercontent.com\/smart-data-models\/dataModel.Streetlighting\/f56f5a7933ab05d7fce1d5adc0847f25a099cdb4\/StreetlightModel\/schema.json&email=alberto.abella@fiware.org Use any data\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"_links":{"self":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/pages\/322","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/comments?post=322"}],"version-history":[{"count":4,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/pages\/322\/revisions"}],"predecessor-version":[{"id":327,"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/pages\/322\/revisions\/327"}],"wp:attachment":[{"href":"https:\/\/smartdatamodels.org\/index.php\/wp-json\/wp\/v2\/media?parent=322"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}