Pre-release. Until the official launch, content may change, including published files.
Skip to content

Source: https://datamodels.jp/en/guide/own-models · Text CC BY 4.0

Your own data models ​

This catalog is for models that many organisations in Japan share. Many good models are not like that:

  • The model is only for one project or one organisation.
  • You are not sure yet, and want to try the model in real work first.
  • The model has nothing to do with Japan or Japanese standards.

Such a model still needs what the catalog gives its models: a fixed URL for the @context, a JSON Schema, and IRIs that open a description. This page shows where to put it.

Which place fits ​

This catalogYour own siteSmart Data Models
ForModels many organisations in Japan shareYour project or organisationThe FIWARE community worldwide
Who decidesA small group, in issues and pull requests (Contributing)YouThe Smart Data Models maintainers
LanguagesJapanese and EnglishYour choice; one is enoughEnglish
Addressdatamodels.jpYour domainsmartdatamodels.org

Not sure? Start on your own site. You can propose a model to this catalog later (below).

Only missing a few attributes in a model of this catalog? Then you need no model of your own: see Adding attributes.

Your own site ​

Your own site publishes the same kinds of files as this catalog: catalog.json, the @context of each version, JSON Schemas, a vocabulary, examples, and a page for every type and attribute, so every IRI opens its description. Such a site is called a node.

A node is static files. GitHub Pages hosts it for free, and you need no server. The datamodels-toolkit makes the files and the workflow that publishes them.

A model on your site can build on a model of this catalog (extend). It names the model it extends, and the toolkit checks that it keeps that model's names and meanings.

Smart Data Models ​

Smart Data Models is the catalog of the FIWARE community, run by FIWARE, TM Forum, IUDX and OASC. It has over 900 models for smart cities, agriculture, energy and more, in English, and its own way to contribute on GitHub. It is a good place for a model that is not about Japan. This catalog builds on it (Other data model catalogs).

Later: from your site to this catalog ​

When a model on your site turns out useful to others in Japan, propose it here like any other model (Contributing). How such a model moves, and what happens to its old IRIs, is not decided yet (#200). Until then, data that uses your site's IRIs keeps working: your site stays where it is.