Skip to content

Commit ed3d366

Browse files
TimoBakxTimoBakx
committed
Added documentation for message parameters
Also added missing documentation of charsetMessage in the Length constraint
1 parent 7a5e035 commit ed3d366

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+584
-0
lines changed

‎reference/constraints/Bic.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,14 @@ message
9595

9696
The default message supplied when the value does not pass the BIC check.
9797

98+
You can use the following parameters in this message:
99+
100+
+------------------+------------------------------------------------+
101+
| Parameter | Description |
102+
+==================+================================================+
103+
| ``{{ value }}`` | The current (invalid) BIC value |
104+
+------------------+------------------------------------------------+
105+
98106
.. include:: /reference/constraints/_payload-option.rst.inc
99107

100108
.. _`Business Identifier Code (BIC)`: https://en.wikipedia.org/wiki/Business_Identifier_Code

‎reference/constraints/Blank.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,12 @@ message
9696

9797
This is the message that will be shown if the value is not blank.
9898

99+
You can use the following parameters in this message:
100+
101+
+------------------+------------------------------------------------+
102+
| Parameter | Description |
103+
+==================+================================================+
104+
| ``{{ value }}`` | The current (invalid) value |
105+
+------------------+------------------------------------------------+
106+
99107
.. include:: /reference/constraints/_payload-option.rst.inc

‎reference/constraints/CardScheme.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,14 @@ message
131131

132132
The message shown when the value does not pass the ``CardScheme`` check.
133133

134+
You can use the following parameters in this message:
135+
136+
+------------------+------------------------------------------------+
137+
| Parameter | Description |
138+
+==================+================================================+
139+
| ``{{ value }}`` | The current (invalid) value |
140+
+------------------+------------------------------------------------+
141+
134142
.. include:: /reference/constraints/_payload-option.rst.inc
135143

136144
.. _`Wikipedia: Issuer identification number (IIN)`: https://en.wikipedia.org/wiki/Bank_card_number#Issuer_identification_number_.28IIN.29

‎reference/constraints/Choice.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,14 @@ This is the message that you will receive if the ``multiple`` option is
335335
set to ``false`` and the underlying value is not in the valid array of
336336
choices.
337337

338+
You can use the following parameters in this message:
339+
340+
+------------------+------------------------------------------------+
341+
| Parameter | Description |
342+
+==================+================================================+
343+
| ``{{ value }}`` | The current (invalid) value |
344+
+------------------+------------------------------------------------+
345+
338346
multipleMessage
339347
~~~~~~~~~~~~~~~
340348

@@ -344,6 +352,14 @@ This is the message that you will receive if the ``multiple`` option is
344352
set to ``true`` and one of the values on the underlying array being checked
345353
is not in the array of valid choices.
346354

355+
You can use the following parameters in this message:
356+
357+
+------------------+------------------------------------------------+
358+
| Parameter | Description |
359+
+==================+================================================+
360+
| ``{{ value }}`` | The current (invalid) value |
361+
+------------------+------------------------------------------------+
362+
347363
minMessage
348364
~~~~~~~~~~
349365

@@ -352,6 +368,14 @@ minMessage
352368
This is the validation error message that's displayed when the user chooses
353369
too few choices per the `min`_ option.
354370

371+
You can use the following parameters in this message:
372+
373+
+------------------+------------------------------------------------+
374+
| Parameter | Description |
375+
+==================+================================================+
376+
| ``{{ limit }}`` | The lower limit of choices |
377+
+------------------+------------------------------------------------+
378+
355379
maxMessage
356380
~~~~~~~~~~
357381

@@ -360,6 +384,14 @@ maxMessage
360384
This is the validation error message that's displayed when the user chooses
361385
too many options per the `max`_ option.
362386

387+
You can use the following parameters in this message:
388+
389+
+------------------+------------------------------------------------+
390+
| Parameter | Description |
391+
+==================+================================================+
392+
| ``{{ limit }}`` | The upper limit of choices |
393+
+------------------+------------------------------------------------+
394+
363395
strict
364396
~~~~~~
365397

‎reference/constraints/Collection.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,14 @@ extraFieldsMessage
319319
The message shown if `allowExtraFields`_ is false and an extra field is
320320
detected.
321321

322+
You can use the following parameters in this message:
323+
324+
+------------------+------------------------------------------------+
325+
| Parameter | Description |
326+
+==================+================================================+
327+
| ``{{ field }}`` | The key of the extra field detected |
328+
+------------------+------------------------------------------------+
329+
322330
allowMissingFields
323331
~~~~~~~~~~~~~~~~~~
324332

@@ -337,4 +345,12 @@ missingFieldsMessage
337345
The message shown if `allowMissingFields`_ is false and one or more fields
338346
are missing from the underlying collection.
339347

348+
You can use the following parameters in this message:
349+
350+
+------------------+----------------------------------------------------+
351+
| Parameter | Description |
352+
+==================+====================================================+
353+
| ``{{ field }}`` | The key of the missing field defined in ``fields`` |
354+
+------------------+----------------------------------------------------+
355+
340356
.. include:: /reference/constraints/_payload-option.rst.inc

‎reference/constraints/Count.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,16 @@ minMessage
127127
The message that will be shown if the underlying collection elements count
128128
is less than the `min`_ option.
129129

130+
You can use the following parameters in this message:
131+
132+
+------------------+------------------------------------------------+
133+
| Parameter | Description |
134+
+==================+================================================+
135+
| ``{{ count }}`` | The current collection size |
136+
+------------------+------------------------------------------------+
137+
| ``{{ limit }}`` | The lower limit |
138+
+------------------+------------------------------------------------+
139+
130140
maxMessage
131141
~~~~~~~~~~
132142

@@ -135,6 +145,16 @@ maxMessage
135145
The message that will be shown if the underlying collection elements count
136146
is more than the `max`_ option.
137147

148+
You can use the following parameters in this message:
149+
150+
+------------------+------------------------------------------------+
151+
| Parameter | Description |
152+
+==================+================================================+
153+
| ``{{ count }}`` | The current collection size |
154+
+------------------+------------------------------------------------+
155+
| ``{{ limit }}`` | The upper limit |
156+
+------------------+------------------------------------------------+
157+
138158
exactMessage
139159
~~~~~~~~~~~~
140160

@@ -143,4 +163,14 @@ exactMessage
143163
The message that will be shown if min and max values are equal and the underlying
144164
collection elements count is not exactly this value.
145165

166+
You can use the following parameters in this message:
167+
168+
+------------------+------------------------------------------------+
169+
| Parameter | Description |
170+
+==================+================================================+
171+
| ``{{ count }}`` | The current collection size |
172+
+------------------+------------------------------------------------+
173+
| ``{{ limit }}`` | The exact expected collection size |
174+
+------------------+------------------------------------------------+
175+
146176
.. include:: /reference/constraints/_payload-option.rst.inc

‎reference/constraints/Country.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,14 @@ message
8585

8686
This message is shown if the string is not a valid country code.
8787

88+
You can use the following parameters in this message:
89+
90+
+------------------+------------------------------------------------+
91+
| Parameter | Description |
92+
+==================+================================================+
93+
| ``{{ value }}`` | The current (invalid) country code |
94+
+------------------+------------------------------------------------+
95+
8896
.. include:: /reference/constraints/_payload-option.rst.inc
8997

9098
.. _`ISO 3166-1 alpha-2`: https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes

‎reference/constraints/Currency.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,14 @@ message
9191

9292
This is the message that will be shown if the value is not a valid currency.
9393

94+
You can use the following parameters in this message:
95+
96+
+------------------+------------------------------------------------+
97+
| Parameter | Description |
98+
+==================+================================================+
99+
| ``{{ value }}`` | The current (invalid) value |
100+
+------------------+------------------------------------------------+
101+
94102
.. include:: /reference/constraints/_payload-option.rst.inc
95103

96104
.. _`3-letter ISO 4217`: https://en.wikipedia.org/wiki/ISO_4217

‎reference/constraints/Date.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,12 @@ message
8787

8888
This message is shown if the underlying data is not a valid date.
8989

90+
You can use the following parameters in this message:
91+
92+
+------------------+------------------------------------------------+
93+
| Parameter | Description |
94+
+==================+================================================+
95+
| ``{{ value }}`` | The current (invalid) value |
96+
+------------------+------------------------------------------------+
97+
9098
.. include:: /reference/constraints/_payload-option.rst.inc

‎reference/constraints/DateTime.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,12 @@ message
8787

8888
This message is shown if the underlying data is not a valid datetime.
8989

90+
You can use the following parameters in this message:
91+
92+
+------------------+------------------------------------------------+
93+
| Parameter | Description |
94+
+==================+================================================+
95+
| ``{{ value }}`` | The current (invalid) value |
96+
+------------------+------------------------------------------------+
97+
9098
.. include:: /reference/constraints/_payload-option.rst.inc

0 commit comments

Comments
 (0)