Repository navigation
Document list/array flag values as deprecated - #40
Open
confidence-agent[bot] wants to merge 1 commit into
Open
confidence-agent[bot] wants to merge 1 commit into
confidence-agent[bot] wants to merge 1 commit into
Conversation
Marks list/array **flag values** (list fields in flag schemas) as deprecated, using docs only. Runtime behavior does not change. ## Changes - `ConfidenceValue::Array`: added a doc comment saying list-valued flags are deprecated, and that the variant itself is still supported for evaluation context and event data. - `ConfidenceValue::as_array`: added a doc note pointing to the above. - `provider/src/conversion_traits.rs`: added a comment on the `ConfidenceValue::Array` → `open_feature::Value::Array` mapping. The mapping is unchanged. - README: new "Deprecation: list/array flag values" section, scoped to flag values only. ## Why no `#[deprecated]` attribute The repo has no public API that is specific to list flags. `SchemaType` has no list variant, and `TypeConversionTrait` has no `Vec` implementation. `ConfidenceValue::Array`, `as_array`/`is_array` and `From<Vec<T>>` are shared with context and event serialization. Putting `#[deprecated]` on them would also warn on those supported uses, so this PR adds documentation only. No signatures changed. No removal date, version bump or release. CHANGELOG.md is left alone because release-please manages it. Suggested release note: *"List/array flag values are deprecated; they continue to resolve. Lists in context/event data are unaffected."* ## Validation - `cargo test` in `confidence/`: 12 passed. - `cargo doc --no-deps` in `confidence/`: builds. - Gap: `provider/` does not build locally. It fails to resolve `spotify_confidence_sdk = "^0.1.1"` from crates.io, which also happens without this change. The provider edit is a comment only.
Contributor
|
Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted. Details: |
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
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.
Marks list/array flag values (list fields in flag schemas) as deprecated, using docs only. Runtime behavior does not change.
Changes
ConfidenceValue::Array: added a doc comment saying list-valued flags are deprecated, and that the variant itself is still supported for evaluation context and event data.ConfidenceValue::as_array: added a doc note pointing to the above.provider/src/conversion_traits.rs: added a comment on theConfidenceValue::Array→open_feature::Value::Arraymapping. The mapping is unchanged.Why no
#[deprecated]attributeThe repo has no public API that is specific to list flags.
SchemaTypehas no list variant, andTypeConversionTraithas noVecimplementation.ConfidenceValue::Array,as_array/is_arrayandFrom<Vec<T>>are shared with context and event serialization. Putting#[deprecated]on them would also warn on those supported uses, so this PR adds documentation only. No signatures changed. No removal date, version bump or release. CHANGELOG.md is left alone because release-please manages it. Suggested release note: "List/array flag values are deprecated; they continue to resolve. Lists in context/event data are unaffected."Validation
cargo testinconfidence/: 12 passed.cargo doc --no-depsinconfidence/: builds.provider/does not build locally. It fails to resolvespotify_confidence_sdk = "^0.1.1"from crates.io, which also happens without this change. The provider edit is a comment only.Source: https://app.confidence.spotify.com/chats/unvny4azpxsjdp5cq7dy
Opened by the Confidence coding agent.