Api Gateway  >  Operations  >  delete_documentation_part

delete_documentation_part

Operation

delete_documentation_part async

delete_documentation_part(input: DeleteDocumentationPartInput, plugins: list[Plugin] | None = None) -> DeleteDocumentationPartOutput

Deletes a documentation part

Parameters:

Name	Type	Description	Default
input	DeleteDocumentationPartInput	An instance of DeleteDocumentationPartInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
DeleteDocumentationPartOutput	An instance of DeleteDocumentationPartOutput.

Input

DeleteDocumentationPartInput dataclass

Deletes an existing documentation part of an API.

Attributes

documentation_part_id class-attribute instance-attribute

documentation_part_id: str | None = None

The identifier of the to-be-deleted documentation part.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

DeleteDocumentationPartOutput dataclass

Dataclass for DeleteDocumentationPartOutput structure.