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 shared types reference

Generated scalar alias and enum reference for Site Pipeline contracts.

This page defines the shared scalar aliases and enums that appear across the generated contract pages.

Back to the reference overview.

Scalar aliases

Type Base type Description
NonEmptyString String Non-empty free-form string.
NonNegativeInteger Integer Integer value greater than or equal to zero.
PositiveInteger Integer Integer value greater than zero.
Identifier String Non-empty symbolic key.
Slug String Stable component identifier.
ArtifactKey String Stable artifact identifier unique within a component.
OriginKey Identifier Key for a publication origin.
SourceKey String Key for a source or repository entry.
ProviderKey String Key for a provider descriptor.
VersionString String Exact version string such as 4.0.0.
RefString String Moving ref name such as main or releases/4.x.
ReferenceString String Typed internal reference string such as route:/docs/development/ or artifact:spark/runtime.
RegexString String Regex pattern stored as text.
SchemaVersion Integer Positive schema version integer.
TimestampString Datetime RFC 3339 / ISO 8601 timestamp value.
LocalPathString String Consumer-local filesystem path that follows host operating-system path rules.
RepoRelativePath String Repository-relative normalized POSIX path that must use forward slashes.
StageRelativePath String Stage-root-relative normalized POSIX path that must use forward slashes.
MountSourceRef String Stable mount source reference such as a path or bundle key.
PublicPath String Resolved normalized POSIX public path such as /docs/development/.
HostnameString String Hostname derived from an origin URL.
UrlString String Absolute public URL.
ProviderBaseUrl String Validated public provider base URL.
ExtensionsObject Object Opaque structured metadata allowed only in explicitly documented extension slots.

Shared enums

Type Values Description
CandidateSelectionMode none, latest, explicit Strategy used to select a candidate version.
CheckFailureThreshold error, warning Lowest severity that causes check to fail.
CliErrorCategory invocation, input, planning, internal Stable high-level failure categories for CLI automation.
DiagnosticSeverity info, warning, error Severity level for pipeline diagnostics.
IndexBehavior full, metadataOnly, none Renderer hint for version/ref index visibility.
LineHeadSelectionMode none, allAuthored, explicit Strategy used to derive a release-line head record.
LinkCheckMode directory, file-html Supported staged public-path resolution strategies for internal page links.
MaterializationInputKind sitePages, siteAssets, vendorAssets, development, namedRef, lineHead, candidate, released Planning/build/watch local-input category.
MaterializationStatus present, missing, stale, unresolved Readiness state of a required local input.
PlanningTarget build, watch Planning intent for later staging behavior.
PublicationState published, hidden, withdrawn, tombstoned Observed provider-side publication state.
RecordKind development, released, candidate, namedRef, lineHead Normalized provider record lifecycle kind.
ReleaseSelectionMode latestPerLine, latestN, allKnown, explicit Strategy used to select a released version.
RouteMode none, prefixAll Locale routing strategy for a published route set.
RunStatus clean, warnings, errors Overall diagnostic class for a run or cycle.
StageCommand build, watch Stable stage-producing command modes.
TrustClass passive, active Trust posture of a mounted content subtree.
WithdrawalBehavior notice, redirect, omit Author-directed behavior for a withdrawn release.