Skip to content

Commit 1ca4f2a

Browse files
committed
Minor README updates
1 parent abcb480 commit 1ca4f2a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ if __name__ == "__main__":
3838
## Usage
3939
To validate parameters with flask-parameter-validation, two conditions must be met.
4040
1. The `@ValidateParameters()` decorator must be applied to the function
41-
2. Type hints ([supported types](#type-hints-and-accepted-input-types)) and a default of a subclass of `Parameter` for the parameters you want to use flask-parameter-validation on
41+
2. Type hints ([supported types](#type-hints-and-accepted-input-types)) and a default of a subclass of `Parameter` must be supplied per parameter flask-parameter-validation parameter
4242

4343

4444
### Enable and customize Validation for a Route with the @ValidateParameters decorator
@@ -49,7 +49,14 @@ The `@ValidateParameters()` decorator takes parameters that alter route validati
4949
| error_handler | `Optional[Response]` | `None` | Overwrite the output format of generated errors, see [Overwriting Default Errors](#overwriting-default-errors) for more |
5050

5151
#### Overwriting Default Errors
52-
By default, the error messages are returned as a JSON response, with the detailed error in the "error" field. However, this can be edited by passing a custom error function into the `ValidateParameters()` decorator. For example:
52+
By default, the error messages are returned as a JSON response, with the detailed error in the "error" field, eg:
53+
```json
54+
{
55+
"error": "Parameter 'age' must be type 'int'"
56+
}
57+
```
58+
59+
However, this can be edited by passing a custom error function into the `ValidateParameters()` decorator. For example:
5360
```py
5461
def error_handler(err):
5562
error_name = type(err)
@@ -74,10 +81,12 @@ The `Parameter` class provides a base for validation common among all input type
7481
|---------------|------------------------------------------------------------------------------------------------------------------------|------------------|
7582
| Route | Parameter passed in the pathname of the URL, such as `/users/<int:id>` | All HTTP Methods |
7683
| Form | Parameter in an HTML form or a `FormData` object in the request body, often with `Content-Type: x-www-form-urlencoded` | POST Methods |
77-
| Json | Parameter in the JSON object in the request body, must have header `Content-Type: application/json` | POST Method |
84+
| Json | Parameter in the JSON object in the request body, must have header `Content-Type: application/json` | POST Methods |
7885
| Query | Parameter in the query of the URL, such as /news_article?id=55 | All HTTP Methods |
7986
| File | Parameter is a file uploaded in the request body | POST Method |
8087

88+
Note: "**POST Methods**" refers to the HTTP methods that send data in the request body, such as POST, PUT, PATCH and DELETE. Although sending data via some methods such as DELETE is not standard, it is supported by Flask and this library.
89+
8190
#### Type Hints and Accepted Input Types
8291
Type Hints allow for inline specification of the input type of a parameter. Some types are only available to certain `Parameter` subclasses.
8392

0 commit comments

Comments
 (0)