Skip to content

GetDocumentationPartsRequest

Source code in docs_src/capo_api_gateway/types/get_documentation_parts_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class GetDocumentationPartsRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    type: NotRequired[
        "capo_api_gateway.types.documentation_part_type.DocumentationPartType"
    ]
    """<p>The type of API entities of the to-be-retrieved documentation parts. </p>"""
    name_query: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of API entities of the to-be-retrieved documentation parts.</p>"""
    path: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The path of API entities of the to-be-retrieved documentation parts.</p>"""
    position: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The current pagination position in the paged result set.</p>"""
    limit: NotRequired["capo_api_gateway.types.nullable_integer.NullableInteger"]
    """<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>"""
    location_status: NotRequired[
        "capo_api_gateway.types.location_status_type.LocationStatusType"
    ]
    """<p>The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for retrieving DocumentationPart resources with content and <code>UNDOCUMENTED</code> for DocumentationPart resources without content.</p>"""

limit instance-attribute 

limit: NotRequired[NullableInteger]

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

location_status instance-attribute 

location_status: NotRequired[LocationStatusType]

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

name_query instance-attribute 

name_query: NotRequired[String]

The name of API entities of the to-be-retrieved documentation parts.

path instance-attribute 

path: NotRequired[String]

The path of API entities of the to-be-retrieved documentation parts.

position instance-attribute 

position: NotRequired[String]

The current pagination position in the paged result set.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.

type instance-attribute 

type: NotRequired[DocumentationPartType]

The type of API entities of the to-be-retrieved documentation parts.