add better description for flow stage binding

#601
goauthentik · Dec 19, 2024 · 5706a3e · 5706a3e
1 parent ac6dc1c
commit 5706a3e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/docs/resources/flow_stage_binding.md b/docs/resources/flow_stage_binding.md
@@ -43,7 +43,7 @@ resource "authentik_flow_stage_binding" "dummy-flow" {
 
 ### Optional
 
-- `evaluate_on_plan` (Boolean) Defaults to `true`.
+- `evaluate_on_plan` (Boolean) Evaluate policies during the Flow planning process. Defaults to `true`.
 - `invalid_response_action` (String) Allowed values:
   - `retry`
   - `restart`
@@ -53,7 +53,7 @@ resource "authentik_flow_stage_binding" "dummy-flow" {
   - `all`
   - `any`
  Defaults to `any`.
-- `re_evaluate_policies` (Boolean) Defaults to `false`.
+- `re_evaluate_policies` (Boolean) Evaluate policies when the Stage is present to the user. Defaults to `false`.
 
 ### Read-Only
 

diff --git a/internal/provider/resource_flow_stage_binding.go b/internal/provider/resource_flow_stage_binding.go
@@ -28,14 +28,16 @@ func resourceFlowStageBinding() *schema.Resource {
 				Required: true,
 			},
 			"evaluate_on_plan": {
-				Type:     schema.TypeBool,
-				Optional: true,
-				Default:  true,
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     true,
+				Description: "Evaluate policies during the Flow planning process.",
 			},
 			"re_evaluate_policies": {
-				Type:     schema.TypeBool,
-				Optional: true,
-				Default:  false,
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Evaluate policies when the Stage is present to the user.",
 			},
 			"order": {
 				Type:     schema.TypeInt,