Skip to content

delete_documentation_part

Operation

delete_documentation_part

delete_documentation_part(request: DeleteDocumentationPartInput | DeleteDocumentationPartInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDocumentationPartInputDict]) -> DeleteDocumentationPartOutput

Deletes a documentation part

Parameters:

Name Type Description Default
request DeleteDocumentationPartInput | DeleteDocumentationPartInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteDocumentationPartInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDocumentationPartOutput

An instance of DeleteDocumentationPartOutput.

delete_documentation_part async

delete_documentation_part(request: DeleteDocumentationPartInput | DeleteDocumentationPartInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDocumentationPartInputDict]) -> DeleteDocumentationPartOutput

Deletes a documentation part

Parameters:

Name Type Description Default
request DeleteDocumentationPartInput | DeleteDocumentationPartInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteDocumentationPartInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDocumentationPartOutput

An instance of DeleteDocumentationPartOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteDocumentationPartInputDict

Bases: TypedDict

Dictionary form of DeleteDocumentationPartInput.

Attributes

documentation_part_id instance-attribute
documentation_part_id: Required[str]

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

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

DeleteDocumentationPartInput dataclass

Bases: _SerdeShape

Deletes an existing documentation part of an API.

Attributes

documentation_part_id class-attribute instance-attribute
documentation_part_id: str | None = ...

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

rest_api_id class-attribute instance-attribute
rest_api_id: str | None = ...

The string identifier of the associated RestApi.

Output

DeleteDocumentationPartOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDocumentationPartOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.