create_request_validator¶
Operation¶
async
¶
create_request_validator(input: CreateRequestValidatorInput, plugins: list[Plugin] | None = None) -> CreateRequestValidatorOutput
Creates a RequestValidator of a given RestApi.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateRequestValidatorInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateRequestValidatorOutput
|
An instance of |
Input¶
dataclass
¶
Creates a RequestValidator of a given RestApi.
Attributes¶
class-attribute
instance-attribute
¶
name: str | None = None
The name of the to-be-created RequestValidator.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
validate_request_body: bool = False
A Boolean flag to indicate whether to validate request body according to
the configured model schema for the method (true) or not (false).
class-attribute
instance-attribute
¶
validate_request_parameters: bool = False
A Boolean flag to indicate whether to validate request parameters,
true, or not false.
Output¶
dataclass
¶
A set of validation rules for incoming Method requests.
Attributes¶
class-attribute
instance-attribute
¶
id: str | None = None
The identifier of this RequestValidator.
class-attribute
instance-attribute
¶
validate_request_body: bool = False
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
class-attribute
instance-attribute
¶
validate_request_parameters: bool = False
A Boolean flag to indicate whether to validate request parameters
(true) or not (false).