1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00

fix: stickness parmeters for stickiness is camelCase (doc)

closes #641
This commit is contained in:
Ivar Conradi Østhus 2020-09-28 13:08:46 +02:00
parent 6cff7704ae
commit 6b69b9845a

View File

@ -28,10 +28,10 @@ A flexible rollout strategy which combines all gradual rollout strategies in to
**Parameters**
- **stickiness** is used to define how we guarantee consistency for gradual rollout. The same userId and the same rollout percentage should give predictable results. Configuration that should be supported:
- **DEFAULT** - Unleash chooses the first value present on the context in defined order userId, sessionId, random.
- **USERID** - guaranteed to be sticky on userId. If userId not present the behaviour would be false
- **SESSIONID** - guaranteed to be sticky on sessionId. If sessionId not present the behaviour would be false.
- **RANDOM** - no stickiness guaranteed. For every isEnabled call it will yield a random true/false based on the selected rollout percentage.
- **default** - Unleash chooses the first value present on the context in defined order userId, sessionId, random.
- **userId** - guaranteed to be sticky on userId. If userId not present the behaviour would be false
- **sessionId** - guaranteed to be sticky on sessionId. If sessionId not present the behaviour would be false.
- **random** - no stickiness guaranteed. For every isEnabled call it will yield a random true/false based on the selected rollout percentage.
- **groupId** is used to ensure that different toggles will **hash differently** for the same user. The groupId defaults to _feature toggle name_, but is overridable by the user to _correlate rollout_ of multiple feature toggles.
- **rollout** The percentage (0-100) you want to enable the feature toggle for.