docs: add Feature Versioning v2 guide and EF_VERSION audit type#7477
Draft
gagantrivedi wants to merge 4 commits intomainfrom
Draft
docs: add Feature Versioning v2 guide and EF_VERSION audit type#7477gagantrivedi wants to merge 4 commits intomainfrom
gagantrivedi wants to merge 4 commits intomainfrom
Conversation
Documents what changes for customers when an environment is migrated to Feature Versioning v2 — the supported write endpoints, the new NEW_VERSION_PUBLISHED webhook event, the EF_VERSION audit-log type, the shifts to plan-limit accounting and change-request payload shape, and the surfaces that are unchanged (SDK output, identity overrides). Also extends the Audit Logs page with the EF_VERSION related_object_type and the per-type field-population rules.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
- Lead now mirrors the UI's "attach versions to feature values and segment overrides" wording instead of the recursive "records each published change as a version of that flag". - Drops bullet-trailing editorial: "gives you explicit control...", "Add this event to your consumer's schema...", "invisible to dashboard users in practice". - Drops the speculative "test in a non-production environment first" recommendation from the Migration section.
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.
Draft / WIP — content has been verified against the codebase but not yet reviewed by Product/CS.
Summary
docs/managing-flags/feature-versioning.mdcovering what changes for customers when Feature Versioning v2 is enabled on an environment: supported write endpoints, the newNEW_VERSION_PUBLISHEDwebhook event, theEF_VERSIONaudit-log type, plan-limit accounting shifts, change-request payload shape, dashboard affordances, and the surfaces that stay the same (SDK output, identity overrides, engine document shape).docs/administration-and-security/governance-and-compliance/audit-logs.mdwith theEF_VERSIONrelated_object_type, the full enum, and the per-type rules for howrelated_object_idandrelated_object_uuidare populated.Deliberately out of scope
_create_initial_feature_versionscross-feature scheduled-FS bug (fix in fix(versioning): scope scheduled-FS query by feature in v2 enable #7449, scope was 3 internal-testing rows).EF_VERSIONaudit rows.multivariate_feature_state_valuesis empty in v2FLAG_UPDATEDpayloads.POST /features/feature-segments/endpoint raises HTTP 500 on a v2 environment.POST/PUT /environments/{api_key}/featurestates/endpoints mutate in place on v2 — documented here as a caveat, but probably worth fixing.Verification
Every behavioural claim was checked against the live codebase by five parallel verification passes. Findings from those passes drove the current wording — in particular:
POST/PUT /featurestates/endpoints mutate in place on v2 — documented with a caution.NEW_VERSION_PUBLISHEDis delivered to environment webhooks only.EF_VERSIONaudit row count is one per feature per published version.related_object_id/related_object_uuidfield usage varies by audit type (the docs page now describes this accurately).Test plan
cd docs && npm install && npm run start)./integrating-with-flagsmith/flagsmith-api-overview/admin-api/updating-flagsresolves.cautionblock on the legacy endpoints.