Skip to content

README.md

Latest commit

 

History

History
34 lines (23 loc) · 2.56 KB

README.md

File metadata and controls

34 lines (23 loc) · 2.56 KB
Raw

The live register

This directory is the live, machine-readable register of Meta-Models described in Registered-Meta-Models. Registration is an act of discovery, not of storage: every entry is a reference to an authoritative source, never a copy of it.

File Meaning
registered-models.csv The flat, searchable index: one row per registered model
entries/ One YAML file per model: the full entry (schema below)
entry.schema.json JSON Schema every entry must validate against

For the catalogue of ~1180 external standards a Meta-Model may import (Schema.org, FHIR, ISO 20022, ...), see External-Models-Registry and external-models.csv; this register lists Meta-Models built on the Vercy standard.

How to find a model

Search registered-models.csv by kind, domain or keyword (it is small enough to read whole), then open the model's file under entries/ for conformance, dependencies and the authoritative source.

How to use a registered model in your Dimension

  1. Open the entry; check license, conformance and status.
  2. Clone or vendor the source.repository at the pinned source.ref (vendor into your model's imports/ per MMAS-Package).
  3. Read the model's own BOOTSTRAP.md and walk it in its declared order (ARCH-017).
  4. Bind it: reference its namespaces from your model, or adapt it and record your changes as deltas in your Dimension; keep the original IDs for federation compatibility.
  5. Respect mastership (ARCH-018): the registered source stays the master of the model; your copy is a mirror or a fork, never a second master.

How to register a model

  1. Copy an existing file in entries/ as a template; fill every required field of entry.schema.json.
  2. Add the matching row to registered-models.csv.
  3. Open a pull request. Review checks: the entry validates against the schema, the source is reachable (or access: restricted is declared), the claimed conformance is plausible, and the id is unused.
  4. Registration does not transfer ownership and can be withdrawn by the Owner at any time (status retired; entries are never deleted, so identifiers stay resolvable).

Entry statuses

draft (registered, evolving) · stable (versioned releases, change-controlled) · deprecated (superseded, pointer to successor) · retired (withdrawn by Owner; tombstone entry remains).