Skip to main content

Module api_evidence

Module api_evidence 

Source
Expand description

Pure, bounded evidence preparation for paired API visibility comparisons.

§Runtime scope

  • Build: always/default.
  • Execution: Surface B support (paired API visibility workflow).
  • Default termivar scan: no.
  • Support: implemented and tested.

See docs/internals/runtime-map.md.

This module deliberately performs no network I/O, knowledge-base writes, rule evaluation, or planning. A host captures two already-authorized JSON views, then compares one explicit visibility dimension. Raw JSON is borrowed only while canonical signatures are calculated and is never retained.

Structs§

ApiComparisonProfile
Deterministic projection and explanation policy for the current comparator.
ApiVisibilityComparator
Pure canonicalizer and comparator for two authorized API response views.
ApiVisibilityLimits
Fail-closed resource limits for canonicalizing one API visibility view.
ApiVisibilityView
A bounded, raw-value-free API response view ready for paired comparison.
JsonPathPattern
Validated RFC 6901 JSON Pointer pattern.
PathDigest
Pseudonymous digest of one structural JSON path.
ProfiledApiVisibilityComparison
Replayable profiled-comparator envelope.
ProfiledApiVisibilityView
Raw-value-free view captured under one explicit projection profile.
ProjectionPolicyId
Stable digest of a complete projection policy.
RedactedVisibilityDiff
Bounded path-only explanation for one visibility comparison.

Enums§

ApiVisibilityEvidenceError
Validation and canonicalization failures for API visibility evidence.
CanonicalizationVersion
Version of the canonical tree-hash encoding used by profiled views.
ComparisonAlgorithmVersion
Version of the high-level projection and comparison algorithm.
ProfiledApiVisibilityError
Validation, capture, and comparison failures for the profiled comparator.
VisibilityExplanationDisposition
Availability of a bounded path explanation for one comparison result.

Constants§

CURRENT_API_COMPARISON_ALGORITHM_VERSION
Current deterministic comparator algorithm.
CURRENT_API_VISIBILITY_CANONICALIZATION_VERSION
Current deterministic canonicalization format.
DEFAULT_API_VISIBILITY_CANONICAL_BYTES
Default maximum number of bytes in either canonical signature stream.
DEFAULT_API_VISIBILITY_DEPTH
Default maximum JSON nesting depth.
DEFAULT_API_VISIBILITY_DIFF_PATHS
Default number of path digests retained by one comparison explanation.
DEFAULT_API_VISIBILITY_FIELDS
Default maximum number of object members in one view.
DEFAULT_API_VISIBILITY_NODES
Default maximum number of JSON values in one view.
HARD_MAX_API_COMPARISON_PATH_BYTES
Hard ceiling for one canonical RFC 6901 path-pattern string.
HARD_MAX_API_COMPARISON_PATH_DEPTH
Hard ceiling for decoded path-pattern segments.
HARD_MAX_API_COMPARISON_PROFILE_PATHS
Hard ceiling for the number of path patterns in one projection profile.
HARD_MAX_API_VISIBILITY_CANONICAL_BYTES
Hard ceiling for either canonical signature stream.
HARD_MAX_API_VISIBILITY_DEPTH
Hard ceiling for the maximum JSON nesting depth accepted by a comparator.
HARD_MAX_API_VISIBILITY_DIFF_PATHS
Hard ceiling for path digests retained by one comparison explanation.
HARD_MAX_API_VISIBILITY_FIELDS
Hard ceiling for the total object members accepted by one captured view.
HARD_MAX_API_VISIBILITY_NODES
Hard ceiling for the maximum JSON values accepted by one captured view.