Skip to content

CreateDocumentationPartRequest

Source code in docs_src/capo_api_gateway/types/create_documentation_part_request.py 
14
15
16
17
18
19
20
21
22
class CreateDocumentationPartRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    location: (
        "capo_api_gateway.types.documentation_part_location.DocumentationPartLocation"
    )
    """<p>The location of the targeted API entity of the to-be-created documentation part.</p>"""
    properties: "capo_api_gateway.types.string.String"
    """<p>The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.</p>"""

location instance-attribute 

location: DocumentationPartLocation

The location of the targeted API entity of the to-be-created documentation part.

properties instance-attribute 

properties: String

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.