Skip to content

delete_documentation_version

Operation

delete_documentation_version

delete_documentation_version(request: DeleteDocumentationVersionInput | DeleteDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDocumentationVersionInputDict]) -> DeleteDocumentationVersionOutput

Deletes a documentation version.

Parameters:

Name Type Description Default
request DeleteDocumentationVersionInput | DeleteDocumentationVersionInputDict | 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[DeleteDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDocumentationVersionOutput

An instance of DeleteDocumentationVersionOutput.

delete_documentation_version async

delete_documentation_version(request: DeleteDocumentationVersionInput | DeleteDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDocumentationVersionInputDict]) -> DeleteDocumentationVersionOutput

Deletes a documentation version.

Parameters:

Name Type Description Default
request DeleteDocumentationVersionInput | DeleteDocumentationVersionInputDict | 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[DeleteDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDocumentationVersionOutput

An instance of DeleteDocumentationVersionOutput.

Input

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

DeleteDocumentationVersionInputDict

Bases: TypedDict

Dictionary form of DeleteDocumentationVersionInput.

Attributes

documentation_version instance-attribute
documentation_version: Required[str]

The version identifier of a to-be-deleted documentation snapshot.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

DeleteDocumentationVersionInput dataclass

Bases: _SerdeShape

Deletes an existing documentation version of an API.

Attributes

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

The version identifier of a to-be-deleted documentation snapshot.

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

The string identifier of the associated RestApi.

Output

DeleteDocumentationVersionOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDocumentationVersionOutput 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.