Skip to content

CreateDocumentationVersionRequest

Source code in docs_src/capo_api_gateway/types/create_documentation_version_request.py 
13
14
15
16
17
18
19
20
21
class CreateDocumentationVersionRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    documentation_version: "capo_api_gateway.types.string.String"
    """<p>The version identifier of the new snapshot.</p>"""
    stage_name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The stage name to be associated with the new documentation snapshot.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A description about the new documentation snapshot.</p>"""

description instance-attribute 

description: NotRequired[String]

A description about the new documentation snapshot.

documentation_version instance-attribute 

documentation_version: String

The version identifier of the new snapshot.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.

stage_name instance-attribute 

stage_name: NotRequired[String]

The stage name to be associated with the new documentation snapshot.