An open data structure for vendor-neutral ship System Integration.
System Integrators today re-key the same function, connection and IO data from disparate source documents on every project. si-schema defines a function-based minimum requirement for cross-system IO information — together with the data sharing and integration testing that build on it.
From documents to a verifiable data structure
si-schema breaks every piece of function and IO data down into a small, stable set of entities. Read them once from existing source documents, and downstream tools generate the rest.
Not only integration, but lifecycle continuity
si-schema is designed to work at commissioning time and still remain useful after delivery. The adopted direction means integration data should become a durable contract, not a one-off project worksheet.
Turn commissioning output into delivery-grade contracts
Handover is treated as a contract transition. The same model carries lifecycle state, compatibility intent, ownership references, and lineage context.
- Preserve traceability from source docs to approved interfaces.
- Expose what changed and what remains compatible over versions.
- Keep ownership and accountability explicit across organizations.
Delivery packages become explainable and governable, with clear ownership and controlled change across revisions.
Compatibility is CI-gated before promotion
The contract-promotion-gate workflow validates old vs new contract revisions, runs si-schema diff-contract, and blocks promotion on compatibility violations. When old_path is not provided, the gate auto-resolves the baseline from the base/default branch
at the same contract path.
Schema reference
The following entities are defined within si-schema. Each plays a specific role in turning a System Integration test sheet into structured data.
Define once, reference by id: this is how duplication is avoided across the schema.
ProjectMeta
Top-level project identifiers and schema version.
Party
Project parties (vendor, integrator, owner) identified by kind.
Component & Module
Component hierarchy and implementation modules.
Contract Layer (WIP)
Work in progress — artefact, interfaces, protocol bindings, mode/authority, alarms, acceptance and lineages.
Function
One full test-sheet page.
Connection
Direct port-to-port edges carrying one signal each.
Signal
One row in the IO classification table.
Enums
Categories, link types, data types and subtypes.
Validation rules
SIG001 – SIG024: cross-reference, ontology, mode-subset, and module-ownership checks.