Model¶
Structure Class¶
Model
dataclass
¶
Bases: _SerdeShape
Represents the data structure of a method's request or response payload.
Attributes¶
content_type
class-attribute
instance-attribute
¶
content_type: str | None = ...
The content-type for the model.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the model.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the model. Must be an alphanumeric string.
schema
class-attribute
instance-attribute
¶
schema: str | None = ...
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.