search

one-data-model / language

(Old repo:) Simple Definition Format (SDF) for One Data Model definitions
7 stars 4 forks source link

The "namespace" and "defaultnamespace" Keys Need Better Documentation #3

Open gerickson opened 5 years ago

gerickson commented 5 years ago

The documentation for "namespace" and "defaultnamespace" need enhanced documentation. With the current documentation, it is unclear how the keys should be used and what the values of those keys is used for.

My impression is that these keys are used to "shortcut" where schema and model definitions, if so published, live on the public web and are strictly limited to qualify file or resource paths and have absolutely nothing to do with over-the-wire qualification of keys / values / tags.

If that's correct, the documentation should be updated to make that more clear as well as specifying that if the schema author has no public web-published schema that these keys can be omitted.

asoloway64 commented 5 years ago

Namespace is a valuable construct to indicate the current scope of the data models within the file.

Namespace can represent:

  1. Source organization models (in original language?)
  2. Source organization models represented in OneDM language (Unmodified?)
  3. Proposed OneDM models
  4. "Approved" OneDM models etc.