Skip to main content
Version: V2-Next

JSON Schema Reference

Model Forge ships eight JSON Schemas (JSON Schema 2020-12). They define the CORE-IRCORE Intermediate RepresentationThe JSON-based exchange format between Model Management, UI, registry, Configuration Adapters and downstream generators. artifact formats, the x-* extension vocabulary and the exchange envelope. The authoritative copies live in model-forge-runtime/src/main/resources/; the files linked here are CI-guarded copies of exactly those schemas.

The schemas are the normative definition of the CORE-IRCORE Intermediate RepresentationThe JSON-based exchange format between Model Management, UI, registry, Configuration Adapters and downstream generators. artifact formats. They are also the source the TypeScript and Zod types in portal-frontend/src/generated/core/ are generated from. Element schemas are validated against the JSON Schema 2020-12 meta-schema on import (ModelForge.importSchema / validateSchema); the typed artifact documents (Mapping, Pipeline, …) are stored as authored — Model Forge does not validate them against these schemas on write.

Schema$idDownload
CORE DataSethttps://civitasconnect.digital/core-dataset/v1dataset.schema.json
CORE DataStructurehttps://civitasconnect.digital/core-datastructure/v1datastructure.schema.json
CORE Mappinghttps://civitasconnect.digital/core/mapping/v1mapping.schema.json
CORE Pipelinehttps://civitasconnect.digital/core/pipeline/v1pipeline.schema.json
CORE DataSourcehttps://civitasconnect.digital/core/datasource/v1datasource.schema.json
CORE DataSinkhttps://civitasconnect.digital/core/datasink/v1datasink.schema.json
CORE JSON Schema Extensionshttps://civitasconnect.digital/core/extensions/v1core-schema-extensions.schema.json
CORE Artifact Envelopehttps://civitasconnect.digital/core/artifact-envelope/v1artifact-envelope.schema.json

Elements carry no CORE-specific schema: an Element is a JSON Schema 2020-12 document and validates against the official meta-schema (https://json-schema.org/draft/2020-12/schema).

Artifact content schemas​

CORE DataSet​

The bracketing manifest of a coherent integration. It references its members by URN (datastructureRefs, mappingRefs, pipelineRefs, dataSourceRefs, dataSinkRefs) and stores no content inline.

FieldTypeMeaning
$schemastring (required)https://civitasconnect.digital/core-dataset/v1
idstring (required)Versioned CORE URNCORE URNThe global identity Model Management assigns to every model artifact: a unique, stable and versionable URN that exists independently of storage location, file names or registry technology. of the DataSet
title, description, versionstringDisplay metadata
datastructureRefs … dataSinkRefsstring[]URNs of the referenced artifacts

See CORE-IR Reference — DataSet for the full semantics and an example manifest.

CORE DataStructure​

A named, versioned grouping of Elements — records which Elements belong together (for example all entities of one imported JSON Schema document).

It is itself a JSON Schema: a $defs library with one entry per member, whose value is a $ref to that member Element's CORE URNCORE URNThe global identity Model Management assigns to every model artifact: a unique, stable and versionable URN that exists independently of storage location, file names or registry technology.. The Elements are stored separately; a bundled or inlined read embeds them again. An optional top-level $ref designates one member as the root shape, so a root-shaped schema can be derived for a client that needs one.

CORE Mapping​

A declarative field-to-field mapping between two Elements. source and target are versioned Element URNs; fields maps target field paths to field operations (direct copy, constant, expression).

CORE Pipeline​

An integration pipeline as a directed acyclic graph: nodes (typed pipeline steps) and edges (connections). debug toggles verbose engine logging.

CORE DataSource​

Connector configuration feeding data into a pipeline. The schema is a oneOf over the source types that exist: MqttDataSource and SqlDataSource. Each variant carries its own fields, and element references the Element describing the payload format.

CORE DataSink​

Connector configuration receiving transformed data from a pipeline. The schema is a oneOf over the sink types that exist: FrostDataSink and PostgisDataSink. element references the Element describing the output row format.

Extension vocabulary​

CORE JSON Schema Extensions​

Defines the x-* keywords CORE documents may carry inside JSON Schemas:

KeywordMeaning
x-core-refForeign-key annotation: the string field holds the CORE URNCORE URNThe global identity Model Management assigns to every model artifact: a unique, stable and versionable URN that exists independently of storage location, file names or registry technology. of another artifact. Registry-aware existence checks run on import — see CORE-IR Reference.
x-xsd-sourcePoints a JSON Schema projection back at the Element version that carries the source XSDXML Schema DefinitionA W3C language for describing the structure of XML documents. Model Management imports XSD into JSON Schema and can serialize an Element as XSD. representation.
x-ui-positionEditor canvas position of a modelled entity.
x-ui-stylesThe editor diagram a stored model carries — nodes, edges, positions, labels. Host-owned and opaque to the registry: the import carries it verbatim and a read splits it off again. Its shape is deliberately permissive.

All x-* keywords are non-validating annotations: schema fidelity guarantees they survive storage and views verbatim.

Exchange format​

CORE Artifact Envelope​

Wraps one artifact content version together with its identity and metadata (artifactId, artifactType, title, labels, firstVersion) for import and exchange. Used when an artifact is transported as a self-contained file rather than through the Java facade.