Skip to content

update_documentation_version

Operation

update_documentation_version

update_documentation_version(request: UpdateDocumentationVersionInput | UpdateDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDocumentationVersionInputDict]) -> UpdateDocumentationVersionOutput

Updates a documentation version.

Parameters:

Name Type Description Default
request UpdateDocumentationVersionInput | UpdateDocumentationVersionInputDict | 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[UpdateDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDocumentationVersionOutput

An instance of UpdateDocumentationVersionOutput.

update_documentation_version async

update_documentation_version(request: UpdateDocumentationVersionInput | UpdateDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDocumentationVersionInputDict]) -> UpdateDocumentationVersionOutput

Updates a documentation version.

Parameters:

Name Type Description Default
request UpdateDocumentationVersionInput | UpdateDocumentationVersionInputDict | 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[UpdateDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateDocumentationVersionOutput

An instance of UpdateDocumentationVersionOutput.

Input

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

UpdateDocumentationVersionInputDict

Bases: TypedDict

Dictionary form of UpdateDocumentationVersionInput.

Attributes

documentation_version instance-attribute
documentation_version: Required[str]

The version identifier of the to-be-updated documentation version.

patch_operations instance-attribute
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None

For more information about supported patch operations, see Patch Operations.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

UpdateDocumentationVersionInput dataclass

Bases: _SerdeShape

Updates an existing documentation version of an API.

Attributes

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

The version identifier of the to-be-updated documentation version.

patch_operations class-attribute instance-attribute
patch_operations: list[PatchOperation] | None = ...

For more information about supported patch operations, see Patch Operations.

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

The string identifier of the associated RestApi.

Output

UpdateDocumentationVersionOutput dataclass

Bases: _SerdeShape

A snapshot of the documentation of an API.

Attributes

created_date class-attribute instance-attribute
created_date: datetime | None = ...

The date when the API documentation snapshot is created.

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

The description of the API documentation snapshot.

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.

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

The version identifier of the API documentation snapshot.