Skip to content

docs: further specify alpha-rules and the permit_empty rule #9818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michalsn merged 4 commits into from
Dec 5, 2025
+12 −8
Merged

docs: further specify alpha-rules and the permit_empty rule #9818

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41d389f
Update validation rules to specify better
wipped Dec 1, 2025
ca2a524
docs: missing dot
wipped Dec 1, 2025
ca8e202
Update permit_empty rule description
wipped Dec 3, 2025
3b08edb
Update permit_empty rule description in validation guide
wipped Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions user_guide_src/source/libraries/validation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -900,26 +900,28 @@ The following is a list of all the native rules that are available to use:
Rule Parameter Description Example
======================= ========== ============================================= ===================================================
alpha No Fails if field has anything other than
alphabetic characters in ASCII.
alphabetic characters in ASCII or is empty.
alpha_dash No Fails if field contains anything other than
alphanumeric characters, underscores or
dashes in ASCII.
dashes in ASCII or is empty.
alpha_numeric No Fails if field contains anything other than
alphanumeric characters in ASCII.
alphanumeric characters in ASCII or is empty.
alpha_numeric_punct No Fails if field contains anything other than
alphanumeric, space, or this limited set of
alphanumeric, space, this limited set of
punctuation characters: ``~`` (tilde),
``!`` (exclamation), ``#`` (number),
``$`` (dollar), ``%`` (percent),
``&`` (ampersand),
``*`` (asterisk), ``-`` (dash),
``_`` (underscore), ``+`` (plus),
``=`` (equals), ``|`` (vertical bar),
``:`` (colon), ``.`` (period).
``:`` (colon), ``.`` (period) or is empty.
alpha_numeric_space No Fails if field contains anything other than
alphanumeric or space characters in ASCII.
alphanumeric or space characters in ASCII or
is empty.
alpha_space No Fails if field contains anything other than
alphabetic characters or spaces in ASCII.
alphabetic characters or spaces in ASCII or
is empty.
decimal No Fails if field contains anything other than
a decimal number. Also accepts a ``+`` or
``-`` sign for the number.
Expand Down Expand Up @@ -974,7 +976,9 @@ not_in_list Yes Fails if field is within a predetermined
numeric No Fails if field contains anything other than
numeric characters.
permit_empty No Allows the field to receive an empty array,
empty string, null or false.
empty string, null or false. When true,
skips all other validation rules except for
required_with and required_without.
regex_match Yes Fails if field does not match the regular ``regex_match[/regex/]``
expression.
required No Fails if the field is an empty array, empty
Expand Down