Skip to content

Fixed Validator methods names #1362

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
adamw merged 1 commit into from
Jul 6, 2021
+2 −2
Merged

Fixed Validator methods names #1362

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions doc/endpoint/validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ To customise error messages that are returned upon validation/decode failures by

Validators for enumerations can be created using:

* `Validator.derivedEnum`, which takes a type parameter. This should be an abstract, sealed base type, and using a
* `Validator.derivedEnumeration`, which takes a type parameter. This should be an abstract, sealed base type, and using a
macro determines the possible values
* `Validator.enum`, which takes the list of possible values
* `Validator.enumeration`, which takes the list of possible values

To properly represent possible values in documentation, the enum validator additionally needs an `encode` method, which
converts the enum value to a raw type (typically a string). This method is inferred *only* if the validator is directly
Expand Down