SysML v2 API

API integration notes, clients, examples, and experiments.

Role in DE4SDV

DE4SDV treats the SysML v2 API repository as the authoritative store for the live model graph. GUI tools, viewers, analysis scripts, and automation should interact with the model through the SysML v2 API instead of exchanging uncontrolled model exports.

GitHub remains the authoritative reviewed project baseline. Generated textual snapshots, rendered view artifacts, sync metadata, validation evidence, and human-facing documentation are versioned in GitHub through pull requests.

See ADR 0005 for the proposed live-repository decision.

Pilot GUI tool

The initial GUI tool choice for the DE4SDV pilot is Eclipse SysON. The pilot uses SysON as the preferred graphical editing environment for the live SysML v2 repository path while keeping the SysML v2 API boundary explicit so other tools can be evaluated later.

SysON is currently treated as a pilot tool, not a mandatory production dependency for contributors.

Initial model slice

The first model slice is the ASELCM-aligned DE4SDV context framing:

• System 1: configurable SDV product line and configured vehicle/software variants.
• System 2: DE4SDV life-cycle engineering and assurance system.
• System 3: DE4SDV open innovation ecosystem.

The first two publication views are:

• system-context
• lifecycle-engineering-system

The view definitions and publication placeholders live under ../textual-notation-of-model/views/.

The current bootstrap procedure is documented in bootstrap-de4sdv-context. The SysON pilot workflow is documented in syson-engineering-workflow.

Proposed sync loop

SysON GUI edit or API tool edit
  -> export textual snapshot and rendered views
  -> update manifests with SysML/SysON project, document, view, and commit metadata
  -> open a draft GitHub pull request
  -> run repository checks and maintainer review
  -> merge to main
  -> privileged/import job updates the live SysML v2 API repository when needed

The sync pipeline must not push generated model updates directly to main.

GitHub import loop

GitHub can still accept reviewed model-source changes. The direction is stricter:

GitHub pull request
  -> public validation and maintainer review
  -> merge to main
  -> privileged/import job updates the SysML v2 repository
  -> import commit records the Git SHA

External contributors should not need model-repository write credentials or private validation tokens to propose changes.

Artifact ownership

• Live model elements: SysML v2 repository owns the current model graph.
• Reviewed baseline: GitHub owns the accepted public project baseline.
• Documentation and ADRs: GitHub owns the narrative and governance record.
• View definitions: GitHub owns DE4SDV viewpoint intent unless a future GUI workflow explicitly moves layout ownership to the model repository.
• Rendered view images: generated artifacts, regenerated by the sync pipeline.