Skip to content

Edits to README for variants #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 20, 2023
Merged

Edits to README for variants #289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1832e1c
add edits for variants
amerjusupovic Oct 18, 2023
51fbca1
fix wording
amerjusupovic Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,8 @@ Allocation logic is similar to the [Microsoft.Targeting](./README.md#MicrosoftTa

You can use variants to override the enabled state of a feature flag. This gives variants an opportunity to extend the evaluation of a feature flag. If a caller is checking whether a flag that has variants is enabled, then variant allocation will be performed to see if an allocated variant is set up to override the result. This is done using the optional variant property `StatusOverride`. By default, this property is set to `None`, which means the variant doesn't affect whether the flag is considered enabled or disabled. Setting `StatusOverride` to `Enabled` allows the variant, when chosen, to override a flag to be enabled. Setting `StatusOverride` to `Disabled` provides the opposite functionality, therefore disabling the flag when the variant is chosen. A feature with a `Status` of `Disabled` cannot be overridden.

If you are using a feature flag with binary variants, the `StatusOverride` property can be very helpful. It allows you to continue using APIs like `IsEnabledAsync` and `FeatureGateAttribute` in your application, all while benefiting from the new features that come with variants, such as percentile allocation and seed.

```
"Allocation": {
"Percentile": [{
Expand All @@ -789,12 +791,10 @@ You can use variants to override the enabled state of a feature flag. This gives
},
"Variants": [
{
"Name": "On",
"ConfigurationValue": true
"Name": "On"
},
{
"Name": "Off",
"ConfigurationValue": false,
"StatusOverride": "Disabled"
}
],
Expand Down