Skip to content

Commit

Permalink
Merge pull request #1415 from Unleash/docs/fix-variant-description
Browse files Browse the repository at this point in the history
fix: correct the description of disabled variants
  • Loading branch information
thomasheartman committed Mar 4, 2022
2 parents 2f8cfc3 + e6d9395 commit b06f543
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/sdks/unleash-proxy.md
Expand Up @@ -215,7 +215,7 @@ The data for a toggle without [variants](../advanced/feature-toggle-variants.md)

- **`name`**: the name of the feature.
- **`enabled`**: whether the toggle is enabled or not. Will always be `true`.
- **`variant`**: describes whether the toggle has variants and, if it does, what variant is active for this user. If a toggle doesn't have any variants, it will always be `{"name": "disabled", "enabled": true}`.
- **`variant`**: describes whether the toggle has variants and, if it does, what variant is active for this user. If a toggle doesn't have any variants, it will always be `{"name": "disabled", "enabled": false}`.

:::note
Unleash uses a fallback variant called "disabled" to indicate that a toggle has no variants. However, you are free to create a variant called "disabled" yourself. In that case you can tell them apart by checking the variant's `enabled` property: if the toggle has no variants, `enabled` will be `false`. If the toggle is the "disabled" variant that you created, it will have `enabled` set to `true`.
Expand Down

0 comments on commit b06f543

Please sign in to comment.