minor #10617 Added documentation for constraint message parameters (TimoBakx)

This PR was merged into the 2.8 branch.

Discussion
----------

Added documentation for constraint message parameters

After #10584, I checked the documentation for the other constraints and updated the possible parameters in messages.

I also added missing documentation for `charsetMessage` in the Length constraint.

Commits
-------

ed3d366 Added documentation for message parameters

Author: javiereguiluz

reference/constraints/Bic.rst

@@ -95,6 +95,14 @@ message
 
 The default message supplied when the value does not pass the BIC check.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) BIC value                |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc
 
 .. _`Business Identifier Code (BIC)`: https://en.wikipedia.org/wiki/Business_Identifier_Code

reference/constraints/Blank.rst

@@ -96,4 +96,12 @@ message
 
 This is the message that will be shown if the value is not blank.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc

reference/constraints/CardScheme.rst

@@ -131,6 +131,14 @@ message
 
 The message shown when the value does not pass the ``CardScheme`` check.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc
 
 .. _`Wikipedia: Issuer identification number (IIN)`: https://en.wikipedia.org/wiki/Bank_card_number#Issuer_identification_number_.28IIN.29

reference/constraints/Choice.rst

@@ -335,6 +335,14 @@ This is the message that you will receive if the ``multiple`` option is
 set to ``false`` and the underlying value is not in the valid array of
 choices.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 multipleMessage
 ~~~~~~~~~~~~~~~
 
@@ -344,6 +352,14 @@ This is the message that you will receive if the ``multiple`` option is
 set to ``true`` and one of the values on the underlying array being checked
 is not in the array of valid choices.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 minMessage
 ~~~~~~~~~~
 
@@ -352,6 +368,14 @@ minMessage
 This is the validation error message that's displayed when the user chooses
 too few choices per the `min`_ option.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ limit }}``  | The lower limit of choices                     |
++------------------+------------------------------------------------+
+
 maxMessage
 ~~~~~~~~~~
 
@@ -360,6 +384,14 @@ maxMessage
 This is the validation error message that's displayed when the user chooses
 too many options per the `max`_ option.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ limit }}``  | The upper limit of choices                     |
++------------------+------------------------------------------------+
+
 strict
 ~~~~~~
 

reference/constraints/Collection.rst

@@ -319,6 +319,14 @@ extraFieldsMessage
 The message shown if `allowExtraFields`_ is false and an extra field is
 detected.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ field }}``  | The key of the extra field detected            |
++------------------+------------------------------------------------+
+
 allowMissingFields
 ~~~~~~~~~~~~~~~~~~
 
@@ -337,4 +345,12 @@ missingFieldsMessage
 The message shown if `allowMissingFields`_ is false and one or more fields
 are missing from the underlying collection.
 
+You can use the following parameters in this message:
+
++------------------+----------------------------------------------------+
+| Parameter        | Description                                        |
++==================+====================================================+
+| ``{{ field }}``  | The key of the missing field defined in ``fields`` |
++------------------+----------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc

reference/constraints/Count.rst

@@ -127,6 +127,16 @@ minMessage
 The message that will be shown if the underlying collection elements count
 is less than the `min`_ option.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ count }}``  | The current collection size                    |
++------------------+------------------------------------------------+
+| ``{{ limit }}``  | The lower limit                                |
++------------------+------------------------------------------------+
+
 maxMessage
 ~~~~~~~~~~
 
@@ -135,6 +145,16 @@ maxMessage
 The message that will be shown if the underlying collection elements count
 is more than the `max`_ option.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ count }}``  | The current collection size                    |
++------------------+------------------------------------------------+
+| ``{{ limit }}``  | The upper limit                                |
++------------------+------------------------------------------------+
+
 exactMessage
 ~~~~~~~~~~~~
 
@@ -143,4 +163,14 @@ exactMessage
 The message that will be shown if min and max values are equal and the underlying
 collection elements count is not exactly this value.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ count }}``  | The current collection size                    |
++------------------+------------------------------------------------+
+| ``{{ limit }}``  | The exact expected collection size             |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc

reference/constraints/Country.rst

@@ -85,6 +85,14 @@ message
 
 This message is shown if the string is not a valid country code.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) country code             |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc
 
 .. _`ISO 3166-1 alpha-2`: https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes

reference/constraints/Currency.rst

@@ -91,6 +91,14 @@ message
 
 This is the message that will be shown if the value is not a valid currency.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc
 
 .. _`3-letter ISO 4217`: https://en.wikipedia.org/wiki/ISO_4217

reference/constraints/Date.rst

@@ -87,4 +87,12 @@ message
 
 This message is shown if the underlying data is not a valid date.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc

reference/constraints/DateTime.rst

@@ -87,4 +87,12 @@ message
 
 This message is shown if the underlying data is not a valid datetime.
 
+You can use the following parameters in this message:
+
++------------------+------------------------------------------------+
+| Parameter        | Description                                    |
++==================+================================================+
+| ``{{ value }}``  | The current (invalid) value                    |
++------------------+------------------------------------------------+
+
 .. include:: /reference/constraints/_payload-option.rst.inc