Skip to content

Model

Source code in docs_src/capo_api_gateway/types/model.py 
11
12
13
14
15
16
17
18
19
20
21
class Model(TypedDict, closed=True):
    id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier for the model resource.</p>"""
    name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of the model. Must be an alphanumeric string.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the model.</p>"""
    schema: NotRequired["capo_api_gateway.types.string.String"]
    r"""<p>The schema for the model. For <code>application/json</code> 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.</p>"""
    content_type: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The content-type for the model.</p>"""

content_type instance-attribute 

content_type: NotRequired[String]

The content-type for the model.

description instance-attribute 

description: NotRequired[String]

The description of the model.

id instance-attribute 

id: NotRequired[String]

The identifier for the model resource.

name instance-attribute 

name: NotRequired[String]

The name of the model. Must be an alphanumeric string.

schema instance-attribute 

schema: NotRequired[String]

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.