IMPORTANT: Developer documentation for the current development branch. This content is unreleased, may change without notice, and must not be treated as Buildish release documentation.

Pipeline file contract index

Generated contract-file tables for authored, provider, and emitted Site Pipeline schemas.

This page groups the published JSON Schemas by authored/provider/emitted file contract.

Back to the reference overview.

File contract groups

Authored input contracts

Consumer-owned and component-owned source-tree contracts that the pipeline reads.

Contract file Root type(s) Schema file Summary
site/component.yaml ComponentMetadataDocumentV1 component-v1.schema.json Stable component identity, repository content roots, and shared lifecycle hints.
site/catalog.yaml SiteCatalogDocumentV1 catalog-v1.schema.json Catalog of components, defaults, sources, origins, and publication rules for one site.

Provider input contracts

Provider-derived snapshot contracts that the pipeline reads.

Contract file Root type(s) Schema file Summary
site/provider-snapshot.json ProviderSnapshotDocumentV1 provider-snapshot-v1.schema.json Normalized provider inventory of releases, candidates, refs, and downloadable assets.

Pipeline-emitted file contracts

Stable files that the pipeline writes into staged or published output trees.

Contract file Root type(s) Schema file Summary
data/_pipeline/aggregate-dependencies.json AggregateDependencyMapV1 aggregate-dependencies-v1.schema.json Coordinator aggregate files and the units that can invalidate them.
data/_pipeline/output-ownership.json OutputOwnershipMapV1 output-ownership-v1.schema.json Ownership map for staged files and directories retained across rebuilds.
data/_pipeline/unit-contributions.json PersistedUnitContributionsV1 unit-contributions-v1.schema.json Per-unit page contribution manifests retained in the visible stage.
data/artifacts.json ArtifactsDataEntry artifacts-data-v1.schema.json Published artifact inventory with version discovery rules, lifecycle hints, and latest-version summaries.
data/candidates.json CandidateAggregateEntry candidates-data-v1.schema.json Published release-candidate inventory with vote status and downloadable assets.
data/compatibility.json CompatibilityAggregateEntry compatibility-data-v1.schema.json Declared compatibility relationships between published identities.
data/components.json ComponentsDataEntry components-data-v1.schema.json Published component inventory with resolved routes, origins, and artifact summaries.
data/content-index.json ContentIndexEntry content-index-data-v1.schema.json Search and navigation index for staged pages with titles, ancestry, and version metadata.
data/diagnostics.json PipelineDiagnosticEntry diagnostics-data-v1.schema.json Structured diagnostics emitted during planning, checking, or staging.
data/mounts.json MountAggregateEntry mounts-data-v1.schema.json Mounted content and asset subtrees published under resolved public paths.
data/providers.json ProvidersDataEntry providers-data-v1.schema.json Loaded provider inventory with display names, base URLs, and fetch timestamps.
data/redirects.json RedirectAggregateEntry redirects-data-v1.schema.json Flat inventory of published redirects and their resolved destination URLs.
data/refs.json RefAggregateEntry refs-data-v1.schema.json Published development, line-head, and named-ref inventory for version navigation.
data/releases.json ReleaseAggregateEntry releases-data-v1.schema.json Published released-version inventory with lifecycle, support, and asset metadata.
data/routes.json RouteAggregateEntry routes-data-v1.schema.json Flat inventory of published routes with resolved URLs, labels, and ownership metadata.
data/translations.json TranslationSetAggregateEntry translations-data-v1.schema.json Translation sibling groups keyed by one shared translation identifier.
manifest.json StageManifestV1 stage-manifest-v1.schema.json Entry point for a stage tree, including roots, formats, and aggregate file locations.

Pipeline-emitted non-file root contracts

Schema-root report and namespace types that do not correspond to one stable checked-in file path.

Root type(s) Schema file Summary
CliFailureReportV1 cli-failure-report-v1.schema.json Versioned CLI failure envelope emitted in place of a requested JSON command report.
CheckReportV1 check-report-v1.schema.json Validation result for one site-pipeline check invocation.
PipelineFrontMatterNamespace front-matter-namespace-v1.schema.json Reserved front matter namespace containing pipeline-derived component and page metadata.
ResolvedMaterializationReportV1 materialization-report-v1.schema.json Planning inventory of required local inputs and their current materialization status.
StageRunReportV1 stage-run-report-v1.schema.json Execution result for one build run or completed watch cycle.