docs(metadata): add guardrails for observed_absent usage#47
Merged
Conversation
- clarify central metadata field-state contract to distinguish observed absence from unavailable data - document that fields not yet ingested must return unavailable, not observed_absent - add point-of-use warning on observedAbsentMetadataFieldState(...) - preserve exported contract and runtime behavior verification: - pnpm test - pnpm run build
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds guardrail documentation to the metadata field-state contract so future code does not misuse
observed_absentfor fields that are not yet ingested.Changes
Updated
src/domain/metadata-field-state.tsBehavior
observed_absentis only valid when the system has explicitly checked a field and confirmed absenceunavailableobserved_absentexportedVerification
pnpm testpnpm run build