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 |
Describes an existing model defined for a RestApi resource.
Synopsis
- data GetModel = GetModel' {}
- newGetModel :: Text -> Text -> GetModel
- getModel_flatten :: Lens' GetModel (Maybe Bool)
- getModel_restApiId :: Lens' GetModel Text
- getModel_modelName :: Lens' GetModel Text
- data Model = Model' {}
- newModel :: Model
- model_contentType :: Lens' Model (Maybe Text)
- model_description :: Lens' Model (Maybe Text)
- model_id :: Lens' Model (Maybe Text)
- model_name :: Lens' Model (Maybe Text)
- model_schema :: Lens' Model (Maybe Text)
Creating a Request
Request to list information about a model in an existing RestApi resource.
See: newGetModel
smart constructor.
GetModel' | |
|
Instances
Create a value of GetModel
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:flatten:GetModel'
, getModel_flatten
- A query parameter of a Boolean value to resolve (true
) all external
model references and returns a flattened model schema or not (false
)
The default is false
.
GetModel
, getModel_restApiId
- The RestApi identifier under which the Model exists.
$sel:modelName:GetModel'
, getModel_modelName
- The name of the model as an identifier.
Request Lenses
getModel_flatten :: Lens' GetModel (Maybe Bool) Source #
A query parameter of a Boolean value to resolve (true
) all external
model references and returns a flattened model schema or not (false
)
The default is false
.
getModel_restApiId :: Lens' GetModel Text Source #
The RestApi identifier under which the Model exists.
Destructuring the Response
Represents the data structure of a method's request or response payload.
See: newModel
smart constructor.
Model' | |
|
Instances
Create a value of Model
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:contentType:Model'
, model_contentType
- The content-type for the model.
$sel:description:Model'
, model_description
- The description of the model.
$sel:id:Model'
, model_id
- The identifier for the model resource.
$sel:name:Model'
, model_name
- The name of the model. Must be an alphanumeric string.
$sel:schema:Model'
, model_schema
- The schema for the model. For application/json
models, this should be
JSON schema draft 4 model. Do not include "\*/" characters in the
description of any properties because such "\*/" characters may be
interpreted as the closing marker for comments in some languages, such
as Java or JavaScript, causing the installation of your API's SDK
generated by API Gateway to fail.
Response Lenses
model_name :: Lens' Model (Maybe Text) Source #
The name of the model. Must be an alphanumeric string.
model_schema :: Lens' Model (Maybe Text) Source #
The schema for the model. For application/json
models, this should be
JSON schema draft 4 model. Do not include "\*/" characters in the
description of any properties because such "\*/" characters may be
interpreted as the closing marker for comments in some languages, such
as Java or JavaScript, causing the installation of your API's SDK
generated by API Gateway to fail.