Clarify validation rule docs

nuwave · Aug 4, 2023 · 3504af5 · 3504af5
1 parent 41465ba
commit 3504af5
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 12 deletions.
diff --git a/docs/6/api-reference/directives.md b/docs/6/api-reference/directives.md
@@ -2945,8 +2945,10 @@ directive @rules(
   This can either be a reference to [Laravel's built-in validation rules](https://laravel.com/docs/validation#available-validation-rules),
   or the fully qualified class name of a custom validation rule.
 
-  Rules that mutate the incoming arguments, such as `exclude_if`, are not supported
-  by Lighthouse. Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
+  Validation rules that mutate the given input values are _not_ supported:
+  - `exclude_if`
+  - `exclude_unless`
+  Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
   """
   apply: [String!]!
 
@@ -2998,6 +3000,11 @@ directive @rulesForArray(
   Specify the validation rules to apply to the field.
   This can either be a reference to any of Laravel's built-in validation rules: https://laravel.com/docs/validation#available-validation-rules,
   or the fully qualified class name of a custom validation rule.
+
+  Validation rules that mutate the given input values are _not_ supported:
+  - `exclude_if`
+  - `exclude_unless`
+  Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
   """
   apply: [String!]!
 

diff --git a/docs/6/security/validation.md b/docs/6/security/validation.md
@@ -228,10 +228,9 @@ they do not grow too complex and can be composed freely.
 
 ## Caveats
 
-### No Mutations
-
-Validation rules that mutate the given input are _not_ supported:
+### No Mutating Rules
 
+Validation rules that mutate the given input values are _not_ supported:
 - `exclude_if`
 - `exclude_unless`
 

diff --git a/docs/master/api-reference/directives.md b/docs/master/api-reference/directives.md
@@ -2945,8 +2945,10 @@ directive @rules(
   This can either be a reference to [Laravel's built-in validation rules](https://laravel.com/docs/validation#available-validation-rules),
   or the fully qualified class name of a custom validation rule.
 
-  Rules that mutate the incoming arguments, such as `exclude_if`, are not supported
-  by Lighthouse. Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
+  Validation rules that mutate the given input values are _not_ supported:
+  - `exclude_if`
+  - `exclude_unless`
+  Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
   """
   apply: [String!]!
 
@@ -2998,6 +3000,11 @@ directive @rulesForArray(
   Specify the validation rules to apply to the field.
   This can either be a reference to any of Laravel's built-in validation rules: https://laravel.com/docs/validation#available-validation-rules,
   or the fully qualified class name of a custom validation rule.
+
+  Validation rules that mutate the given input values are _not_ supported:
+  - `exclude_if`
+  - `exclude_unless`
+  Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
   """
   apply: [String!]!
 

diff --git a/docs/master/security/validation.md b/docs/master/security/validation.md
@@ -228,10 +228,9 @@ they do not grow too complex and can be composed freely.
 
 ## Caveats
 
-### No Mutations
-
-Validation rules that mutate the given input are _not_ supported:
+### No Mutating Rules
 
+Validation rules that mutate the given input values are _not_ supported:
 - `exclude_if`
 - `exclude_unless`
 

diff --git a/src/Validation/RulesDirective.php b/src/Validation/RulesDirective.php
@@ -18,8 +18,10 @@ public static function definition(): string
   This can either be a reference to [Laravel's built-in validation rules](https://laravel.com/docs/validation#available-validation-rules),
   or the fully qualified class name of a custom validation rule.
 
-  Rules that mutate the incoming arguments, such as `exclude_if`, are not supported
-  by Lighthouse. Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
+  Validation rules that mutate the given input value are _not_ supported:
+  - `exclude_if`
+  - `exclude_unless`
+  Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
   """
   apply: [String!]!
 

diff --git a/src/Validation/RulesForArrayDirective.php b/src/Validation/RulesForArrayDirective.php
@@ -18,6 +18,11 @@ public static function definition(): string
   Specify the validation rules to apply to the field.
   This can either be a reference to any of Laravel's built-in validation rules: https://laravel.com/docs/validation#available-validation-rules,
   or the fully qualified class name of a custom validation rule.
+
+  Validation rules that mutate the given input values are _not_ supported:
+  - `exclude_if`
+  - `exclude_unless`
+  Use ArgTransformerDirectives or FieldMiddlewareDirectives instead.
   """
   apply: [String!]!