docs: add guide for experimental flag update endpoints#7083
docs: add guide for experimental flag update endpoints#7083gagantrivedi wants to merge 4 commits intomainfrom
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit at claude.ai/admin-settings/claude-code.
Once credits are available, reopen this pull request to trigger a review.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
emyller
left a comment
emyller
left a comment
There was a problem hiding this comment.
Looks good overall. One blocking note.
|
|
||
| These experimental endpoints let you update feature flag values and segment overrides via the Admin API. They're | ||
| purpose-built for automation and CI/CD — minimal payloads, no need to look up internal IDs, and they work the same | ||
| regardless of whether your environment uses v1 or v2 feature versioning. |
There was a problem hiding this comment.
(...) and they work the same regardless of whether your environment uses v1 or v2 feature versioning.
I think this piece would only make sense in user documentation if it also educates users about what v1 and v2 feature versioning systems are beforehand — it's not a topic in documentation. Otherwise it might be deixis to delete.
There was a problem hiding this comment.
Updated — now refers to "Feature Versioning" being enabled or not, without the v1/v2 terminology.
| title: Updating Flags | ||
| sidebar_label: Updating Flags |
There was a problem hiding this comment.
| title: Updating Flags | |
| sidebar_label: Updating Flags | |
| title: Updating Flags (Experimental) | |
| sidebar_label: Updating Flags (Experimental) |
The title currently looks like the go-to place for learning how to update flags. Would it improve to make it explicitly experimental?
There was a problem hiding this comment.
Done — added (Experimental) to both title and sidebar label.
|
|
||
| ## Remove a segment override | ||
|
|
||
| Removes a segment override from a feature. |
There was a problem hiding this comment.
The doc says "We're evaluating two approaches for updating flags", so this endpoint was a surprise. 😅
| Removes a segment override from a feature. | |
| Neither Option A nor B support deleting segment overrides. This separate endpoint uses a similar interface to achieve that: |
P.S. Should this be a DELETE call to either endpoints?
There was a problem hiding this comment.
P.S. Should this be a DELETE call to either endpoints?
This is outside the scope of this documentation
There was a problem hiding this comment.
Updated the intro line to clarify this is a separate endpoint, not part of the Option A/B comparison.
Address review comment — avoid unexplained v1/v2 terminology.
3 participants
Summary
update-flag-v1,update-flag-v2,delete-segment-override)Closes #6856
Test plan
api/api/urls/experiments.py