Skip to main content

Crate helm_schema_core

Crate helm_schema_core 

Source
Expand description

Shared semantic contracts used by Helm analysis and schema providers.

Modules§

guard_algebra
Normalization helpers for conjunction and disjunction guard sets.

Structs§

ConditionalOverlayEvidence
Branch-local evidence for one conditional schema overlay.
ConditionalPathOverlay
Conditionally-scoped values path whose schema can be lowered under a values-decidable guard set.
ContractFailImplication
One fail-branch implication on a values path.
ContractPathSchemaEvidence
All schema-lowering evidence for one values path.
ContractProvenance
Source provenance for one emitted contract fact.
ContractRequirednessEvidence
Path-local evidence consumed by the optional --infer-required post-pass.
ContractSchemaSignals
Contract-derived facts consumed by core values-schema generation.
ContractUse
A contract claim for one observed values path.
ContractValuePathFacts
Schema-generation facts for one input values path.
GuardDnf
Disjunction of conjunctions of typed predicates.
HelperBranch
One branch of an if/elif/else chain in a helper or manifest header.
KindBranch
One arm of a values-predicate-selected kind: chain (kind: {{ if $stateful }}StatefulSet{{ else }}Deployment{{ end }}).
MergeLayersUse
The value is one layer of an ordered Sprig merge: a key of an earlier layer shadows the same key of every later layer at the rendered sink, so a later layer’s member reaches the sink only where every earlier layer lacks that member.
ProviderSchemaFragment
Schema fragment returned by a provider for one resource/path lookup.
ProviderSchemaSource
Provider document location that produced a schema fragment.
ProviderSchemaUse
Contract fact that needs a Kubernetes resource schema lookup.
ProviderSourceFragment
Provider-owned source leaf.
ResourceRef
Detected Kubernetes resource type (apiVersion + kind).
SourceSpan
Byte span within a template source file.
SplitSegmentUse
The rendered text is ONE SEGMENT of the source string split by a literal separator (regexSplit ":" . -1 | last extracting a port suffix): the sink schema constrains that segment, never the whole raw value.
ValuesDefaultSource
A chart-wide default subtree merged into an effective .Values subtree.
ValuesProgramWrapper
A chart-authored values-program wrapper convention: within scope_path (empty for the whole values tree), any node may be a singleton {key: PROGRAM} map that the chart’s engine replaces with the tpl-rendered, YAML-reparsed program result before consumers read it.
YamlPath
YAML path in the rendered manifest, e.g. ["metadata", "name"].

Enums§

ApiPresenceQuery
A typed .Capabilities.APIVersions.Has ... query.
CapabilityGuard
Structurally-decoded capability guard for an if action.
ConditionalGuard
Values-decidable guard expression that can be lowered into JSON Schema conditionals.
ContractRequirementTarget
Runtime value within a values-path contract that must satisfy a requirement.
FailValueRequirement
One requirement a fail branch imposes on an affected value.
Guard
A guard condition from an if, with, or range block.
GuardValue
Scalar literal used by values-decidable guard comparisons.
HelperBranchBody
What a HelperBranch produces when its guard is live.
MetadataFieldKind
Kubernetes metadata.* field shape referenced by a values path.
Predicate
Typed Boolean formula recovered from template control flow.
ProviderOrigin
Identifies which provider produced a lookup result.
QuotedScalarStyle
The quoting style of a manually quoted YAML scalar hosting a raw splice.
ValueKind
How a value contributes to rendered YAML.

Constants§

DYNAMIC_MAPPING_VALUE_SEGMENT
Structural path segment for the value of a rendered mapping entry whose key is supplied by a template expression.

Traits§

CapabilityOracle
Authoritative answer to a parsed .Capabilities.APIVersions.Has query for a specific Kubernetes version.
ResourceSchemaOracle
Provides JSON Schema fragments for Kubernetes resource fields.

Functions§

append_relative_path
Appends a rendered YAML path relative to a base path.
append_value_path
Appends one structural segment to an encoded .Values path.
dynamic_mapping_value_path
Appends the structural dynamic-key value segment to a rendered YAML path.
join_value_path
Joins structural .Values path segments into the contract path currency.
live_literals
Resolve a typed-branch chain to the literal alternatives the chart would emit at runtime for the target K8s version. If a non-empty branch is not statically decidable, return no chosen branch so callers preserve all candidates instead of collapsing ambiguity to source order.
normalize_schema_pattern_dialects
Normalize regex dialects in every schema-position pattern keyword and patternProperties key. Provider schemas carry Go/RE2 spellings — notably a leading global (?i) — that Draft-07’s ECMA-262 dialect rejects; conforming validators refuse the whole schema over one such pattern. Runs once at provider-fragment ingestion, the boundary where foreign dialect text enters the system, so every downstream consumer sees portable spellings. Rewrites are language-exact (a case fold, never a widening), so an untranslatable pattern stays as-is for the fixture hygiene gate to report rather than silently changing what the schema accepts.
sequence_item_path
Marks the final path segment as a sequence-item collection slot.
split_value_path
Splits the contract .Values path currency into structural segments.
values_path_has_descendant
Reports whether sources contains a strict descendant of path.
values_path_is_descendant
Reports whether path is a strict segmented descendant of ancestor.