Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes an existing model defined for a RestApi
resource.
- getModel :: Text -> Text -> GetModel
- data GetModel
- ggFlatten :: Lens' GetModel (Maybe Bool)
- ggRestAPIId :: Lens' GetModel Text
- ggModelName :: Lens' GetModel Text
- model :: Model
- data Model
- mSchema :: Lens' Model (Maybe Text)
- mName :: Lens' Model (Maybe Text)
- mId :: Lens' Model (Maybe Text)
- mDescription :: Lens' Model (Maybe Text)
- mContentType :: Lens' Model (Maybe Text)
Creating a Request
Creates a value of GetModel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ggFlatten
- 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 isfalse
.ggRestAPIId
- TheRestApi
identifier under which theModel
exists.ggModelName
- The name of the model as an identifier.
Request to list information about a model in an existing RestApi
resource.
See: getModel
smart constructor.
Request Lenses
ggFlatten :: 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
.
Destructuring the Response
Creates a value of Model
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mSchema
- The schema for the model. Forapplication/json
models, this should be JSON-schema draft v4 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.mName
- The name of the model.mId
- The identifier for the model resource.mDescription
- The description of the model.mContentType
- The content-type for the model.
Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
Method
, MethodResponse
, Models and Mappings
See: model
smart constructor.
Response Lenses
mSchema :: Lens' Model (Maybe Text) Source #
The schema for the model. For application/json
models, this should be JSON-schema draft v4 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.