Skip to content

GetModelRequest

Source code in docs_src/capo_api_gateway/types/get_model_request.py
class GetModelRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The RestApi identifier under which the Model exists.</p>"""
    model_name: "capo_api_gateway.types.string.String"
    """<p>The name of the model as an identifier.</p>"""
    flatten: "capo_api_gateway.types.boolean.Boolean"
    """<p>A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.</p>"""

flatten instance-attribute

flatten: Boolean

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.

model_name instance-attribute

model_name: String

The name of the model as an identifier.

rest_api_id instance-attribute

rest_api_id: String

The RestApi identifier under which the Model exists.