RAMEN Core
    Preparing search index...

    JSON Schemas

    The package includes six JSON schemas. Use a file schema for export and import, a model schema for one model level, and the instance schema for recorded data.

    Schema Purpose
    model.schema.json One generic RMF model level, including its nodes, data types, properties, relationships and imports. Matches getModel().
    ramen-project.schema.json One RAMEN project level. Adds annotation definitions to the generic model structure. Matches getModel().
    ramen-annotations.schema.json The annotations section and its reusable definitions. Included in the RAMEN project schema. It describes permitted annotation shapes, not recorded annotations.
    Schema Purpose
    model-file.schema.json One RMF export containing the selected level and its predecessors. Shared declaration lists preserve ownership and inheritance so import can restore the levels.
    ramen-file.schema.json The RAMEN export format. Also preserves annotation definitions and their declaring levels.

    See RMF export and import and RAMEN export and import.

    Schema Purpose
    model-instances.schema.json An instance graph with recorded nodes, property values and relationships. The same structure is used for RMF and RAMEN data validation.

    The instance schema checks the graph's JSON structure. Checking values, permitted relationships and annotation shapes against a particular model requires the library's data validation.

    Every filename above is available as @ramen-suite/core/schemas/<filename>. The build copies the schemas from src/resources/schemas/ to dist/ramen-core/schemas/.

    The links above are the versioned canonical $id values declared in the schemas. They identify the format even before the corresponding website paths are published. The packaged copies are available without fetching those URLs.

    https://ramen-schema.org/ramen/1.0.0/model.json identifies the built-in RAMEN reference model. It is a model document, not an additional JSON schema.

    The npm package version identifies the implementation and public API. Schema $id values identify document formats, while the RAMEN reference model has its own identity and vocabulary version. These versions are independent; a package update does not necessarily change the file format.

    See Contributing for publishing the schemas and reference model to their canonical URLs.