diff --git a/concepts.mdx b/concepts.mdx index 53497ec..c7f369b 100644 --- a/concepts.mdx +++ b/concepts.mdx @@ -122,11 +122,6 @@ Currently 5 constraint types are available: ## Rules - - Rules are only available for [Variant](#variants) flags. This was the only - flag type available pre-v1.24.0 of Flipt. - - Rules allow you to tie your flags, variants and segments together by specifying which segments are targeted by which variants. @@ -142,6 +137,14 @@ Rules are evaluated in order per their rank from 1-N. The first rule that matches wins. Once created, rules can be re-ordered to change how they're evaluated. +### Default Rule + +Default Rules are available since v1.74.0 of Flipt. + +If no rules match for a given flag, the default rule value is returned. This value is optional and can be set to any variant that exists for the flag. + +![Default Rule Example](/images/concepts/default_rule.png) + ### Distributions Distributions allow you to return different variants of your flag to different @@ -157,14 +160,9 @@ The ability to manage distributions, as illustrated in the image above, is an ex ## Rollouts - - Rollouts are only available for [Boolean](#boolean) flags. Rollouts were - introduced in v1.24.0 of Flipt. - - -Boolean flags return `true` or `false` based on the flags `enabled` property. Rollouts allow you to potentially change this value at request time. +Rollouts allow you to potentially change the result of a boolean flag value at request time. -Rollouts are a sequence of conditions which when one is matched for a request context, overrides the flag's `enabled` property. +Rollouts are a sequence of conditions which when one is matched for a request context, overrides the default rollout property. Current rollout types include: @@ -175,6 +173,10 @@ Current rollout types include: Rollouts work similar to [Rules](#rules) in that they're evaluated in order per their rank from 1-N. The first rollout that matches wins. Once created, rollouts can be re-ordered to change how they're evaluated. +### Default Rollout + +If no rollouts match for a given flag, the default rollout value is returned. This value is the same as the 'enabled' value for the flag for backward compatibility reasons. + ## Evaluation Evaluation is the process of sending requests to the Flipt server to process and diff --git a/images/concepts/default_rule.png b/images/concepts/default_rule.png new file mode 100644 index 0000000..7d1bebd Binary files /dev/null and b/images/concepts/default_rule.png differ diff --git a/images/concepts/flags_boolean.png b/images/concepts/flags_boolean.png index 0890cdd..3598f4e 100644 Binary files a/images/concepts/flags_boolean.png and b/images/concepts/flags_boolean.png differ diff --git a/images/concepts/rollouts.png b/images/concepts/rollouts.png index 072238b..9f56546 100644 Binary files a/images/concepts/rollouts.png and b/images/concepts/rollouts.png differ diff --git a/openapi.yaml b/openapi.yaml index f186b29..94d7301 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: api - version: 1.46.0 + version: 1.47.0 paths: /evaluate/v1/boolean: post: