get_documentation_parts ¶

get_documentation_parts(
    rest_api_id: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    type: Optional[DocumentationPartType] = None,
    name_query: Optional[String] = None,
    path: Optional[String] = None,
    position: Optional[String] = None,
    limit: Optional[NullableInteger] = None,
    location_status: Optional[LocationStatusType] = None,
) -> DocumentationParts

Gets documentation parts.

Parameters:

rest_api_id (String) –

The string identifier of the associated RestApi.
type (Optional[DocumentationPartType], default: None ) –

The type of API entities of the to-be-retrieved documentation parts.
name_query (Optional[String], default: None ) –

The name of API entities of the to-be-retrieved documentation parts.
path (Optional[String], default: None ) –

The path of API entities of the to-be-retrieved documentation parts.
position (Optional[String], default: None ) –

The current pagination position in the paged result set.
limit (Optional[NullableInteger], default: None ) –

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
location_status (Optional[LocationStatusType], default: None ) –

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.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def get_documentation_parts(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    type: Optional[
        "capo_api_gateway.types.documentation_part_type.DocumentationPartType"
    ] = None,
    name_query: Optional["capo_api_gateway.types.string.String"] = None,
    path: Optional["capo_api_gateway.types.string.String"] = None,
    position: Optional["capo_api_gateway.types.string.String"] = None,
    limit: Optional[
        "capo_api_gateway.types.nullable_integer.NullableInteger"
    ] = None,
    location_status: Optional[
        "capo_api_gateway.types.location_status_type.LocationStatusType"
    ] = None,
) -> "capo_api_gateway.types.documentation_parts.DocumentationParts":
    """<p>Gets documentation parts.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        type: <p>The type of API entities of the to-be-retrieved documentation parts. </p>
        name_query: <p>The name of API entities of the to-be-retrieved documentation parts.</p>
        path: <p>The path of API entities of the to-be-retrieved documentation parts.</p>
        position: <p>The current pagination position in the paged result set.</p>
        limit: <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
        location_status: <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>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.get_documentation_parts_request.GetDocumentationPartsRequest]",
    ) -> OperationResponse[
        "capo_api_gateway.types.documentation_parts.DocumentationParts"
    ]:
        import capo_api_gateway._operations.backplane_control_service.get_documentation_parts

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.get_documentation_parts.get_documentation_parts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDocumentationParts")
    )
    input_: capo_api_gateway.types.get_documentation_parts_request.GetDocumentationPartsRequest = {
        "rest_api_id": rest_api_id
    }
    if type is not None:
        input_["type"] = type
    if name_query is not None:
        input_["name_query"] = name_query
    if path is not None:
        input_["path"] = path
    if position is not None:
        input_["position"] = position
    if limit is not None:
        input_["limit"] = limit
    if location_status is not None:
        input_["location_status"] = location_status

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output