Dashboard Summary Surface¶

Status: Candidate post-v1 Core-owned structured surface consolidated in v1.1.0
Scope: dashboard foundation summary
Applies to: OrbitFabric Core v1.1.0 - Candidate Integration Surface Consolidation and later, until any future promotion decision

The Dashboard Summary Surface is a Core-owned read-only JSON report that aggregates existing Core-owned facts into a dashboard foundation.

It does not introduce coverage metrics.

Coverage metrics live in the separate coverage_summary.json candidate surface.

It does not introduce a mission health score.

It does not introduce runtime behavior, ground behavior, plugin execution, graph behavior or Studio-specific APIs.

Generated by¶

orbitfabric export dashboard-summary examples/demo-3u/mission/ \
  --json examples/demo-3u/generated/reports/dashboard_summary.json

If --json is omitted, the default output path is mission-workspace relative.

For examples/demo-3u/mission/, the default output path is:

examples/demo-3u/generated/reports/dashboard_summary.json

An explicit --json path is preserved unchanged.

dashboard-summary is mission-based and therefore follows the workspace-relative generated artifact default rule.

Output identity¶

{
  "kind": "orbitfabric.dashboard_summary",
  "dashboard_version": "0.1-candidate"
}

The dashboard_version value is a report format identifier.

It does not mean the surface is part of the v1.0.0 stable surface.

Purpose¶

The report answers:

What dashboard-ready Core facts are available for this Mission Model?

It aggregates:

Mission identity
validation summary
model domain inventory
entity inventory summary
relationship inventory summary
coverage availability status

The report is intended for downstream tools and CI inspection.

Downstream tools should render the report; they must not add private Mission Data Contract semantics.

Top-level fields¶

dashboard_version
kind
orbitfabric_version
mission
source
boundaries
validation
model_domains
entity_inventory
relationship_inventory
coverage

Boundary flags¶

The report declares its own boundaries.

Important flags include:

source_of_truth = mission_model
core_derived_report = true
read_only = true
contains_dashboard_summary = true
contains_coverage_metrics = false
contains_health_score = false
contains_scenario_run_index = false
contains_expectation_accounting = false
contains_relationship_graph = false
contains_dependency_graph = false
contains_yaml_ast = false
contains_source_locations = false
contains_plugin_api = false
contains_studio_api = false
contains_runtime_behavior = false
contains_ground_behavior = false

These flags are part of the report boundary.

They prevent consumers from treating the dashboard summary as a coverage report, graph, Studio API or runtime surface.

Validation section¶

The validation section is derived from the Core lint engine.

Shape:

{
  "validation": {
    "tool": "orbitfabric-lint",
    "result": "passed",
    "errors": 0,
    "warnings": 0,
    "info": 0
  }
}

Current result values:

passed
passed_with_warnings
failed

Model domains section¶

The model domains section summarizes required and optional domain presence and loaded counts.

It is derived from the loaded Mission Model and the same domain inventory used by model_summary.json.

It is inventory, not completeness scoring.

Consumers must not convert domain presence into a private model-completeness percentage.

Entity inventory section¶

The entity inventory section summarizes entity counts derived from the entity index surface.

It is inventory, not coverage.

A declared entity is not automatically covered by scenario evidence.

Relationship inventory section¶

The relationship inventory section summarizes relationship counts derived from the relationship manifest surface.

It is inventory, not relationship coverage.

A declared relationship is not automatically exercised by scenario evidence.

Coverage section¶

The dashboard summary explicitly marks coverage as unavailable inside this report.

Shape:

{
  "coverage": {
    "status": "not_available",
    "reason": "Coverage metrics are not emitted by OrbitFabric Core in this report version.",
    "requires_core_output": "coverage_summary.json"
  }
}

This is intentional.

Coverage is defined separately by the dedicated Core-owned candidate surface coverage_summary.json.

Downstream tools should render this status as Unavailable, Requires Core output or equivalent when only dashboard_summary.json is available.

They must not compute coverage from raw YAML, logs, generated Markdown, terminal output or UI state.

Compatibility posture¶

dashboard_summary.json is introduced as a candidate post-v1 Core-owned structured surface and consolidated in v1.1.0.

It is not part of the original v1.0.0 stable surface.

Future promotion to a stronger compatibility class requires a separate reviewed decision and, if appropriate, golden signature protection for selected contract-significant fields.

Non-goals¶

The dashboard summary does not provide:

coverage metrics
model completeness score
mission health score
scenario run index
structured expectation accounting
runtime facts
live telemetry
command uplink
relationship graph behavior
dependency graph behavior
Studio-specific API
plugin execution

Final statement¶

The dashboard summary is the first Core-owned dashboard foundation surface.

It is deliberately narrow:

aggregate existing Core facts
expose explicit boundaries
point to coverage_summary.json when coverage is required