Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a RequestValidator of a given RestApi.
Synopsis
- data CreateRequestValidator = CreateRequestValidator' {}
- newCreateRequestValidator :: Text -> CreateRequestValidator
- createRequestValidator_name :: Lens' CreateRequestValidator (Maybe Text)
- createRequestValidator_validateRequestBody :: Lens' CreateRequestValidator (Maybe Bool)
- createRequestValidator_validateRequestParameters :: Lens' CreateRequestValidator (Maybe Bool)
- createRequestValidator_restApiId :: Lens' CreateRequestValidator Text
- data RequestValidator = RequestValidator' {}
- newRequestValidator :: RequestValidator
- requestValidator_id :: Lens' RequestValidator (Maybe Text)
- requestValidator_name :: Lens' RequestValidator (Maybe Text)
- requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool)
- requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool)
Creating a Request
data CreateRequestValidator Source #
Creates a RequestValidator of a given RestApi.
See: newCreateRequestValidator
smart constructor.
CreateRequestValidator' | |
|
Instances
newCreateRequestValidator Source #
Create a value of CreateRequestValidator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRequestValidator
, createRequestValidator_name
- The name of the to-be-created RequestValidator.
CreateRequestValidator
, createRequestValidator_validateRequestBody
- A Boolean flag to indicate whether to validate request body according to
the configured model schema for the method (true
) or not (false
).
CreateRequestValidator
, createRequestValidator_validateRequestParameters
- A Boolean flag to indicate whether to validate request parameters,
true
, or not false
.
CreateRequestValidator
, createRequestValidator_restApiId
- The string identifier of the associated RestApi.
Request Lenses
createRequestValidator_name :: Lens' CreateRequestValidator (Maybe Text) Source #
The name of the to-be-created RequestValidator.
createRequestValidator_validateRequestBody :: Lens' CreateRequestValidator (Maybe Bool) Source #
A Boolean flag to indicate whether to validate request body according to
the configured model schema for the method (true
) or not (false
).
createRequestValidator_validateRequestParameters :: Lens' CreateRequestValidator (Maybe Bool) Source #
A Boolean flag to indicate whether to validate request parameters,
true
, or not false
.
createRequestValidator_restApiId :: Lens' CreateRequestValidator Text Source #
The string identifier of the associated RestApi.
Destructuring the Response
data RequestValidator Source #
A set of validation rules for incoming Method requests.
See: newRequestValidator
smart constructor.
RequestValidator' | |
|
Instances
newRequestValidator :: RequestValidator Source #
Create a value of RequestValidator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:RequestValidator'
, requestValidator_id
- The identifier of this RequestValidator.
$sel:name:RequestValidator'
, requestValidator_name
- The name of this RequestValidator
$sel:validateRequestBody:RequestValidator'
, requestValidator_validateRequestBody
- A Boolean flag to indicate whether to validate a request body according
to the configured Model schema.
$sel:validateRequestParameters:RequestValidator'
, requestValidator_validateRequestParameters
- A Boolean flag to indicate whether to validate request parameters
(true
) or not (false
).
Response Lenses
requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #
The identifier of this RequestValidator.
requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #
The name of this RequestValidator
requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #
A Boolean flag to indicate whether to validate request parameters
(true
) or not (false
).