Api Gateway  >  Operations  >  update_documentation_version

update_documentation_version

Operation

update_documentation_version async

update_documentation_version(input: UpdateDocumentationVersionInput, plugins: list[Plugin] | None = None) -> UpdateDocumentationVersionOutput

Updates a documentation version.

Parameters:

Name	Type	Description	Default
input	UpdateDocumentationVersionInput	An instance of UpdateDocumentationVersionInput.	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
UpdateDocumentationVersionOutput	An instance of UpdateDocumentationVersionOutput.

Input

UpdateDocumentationVersionInput dataclass

Updates an existing documentation version of an API.

Attributes

documentation_version class-attribute instance-attribute

documentation_version: str | None = None

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

patch_operations class-attribute instance-attribute

patch_operations: list[PatchOperation] | None = None

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

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

UpdateDocumentationVersionOutput dataclass

A snapshot of the documentation of an API.

Attributes

created_date class-attribute instance-attribute

created_date: datetime | None = None

The date when the API documentation snapshot is created.

description class-attribute instance-attribute

description: str | None = None

The description of the API documentation snapshot.

version class-attribute instance-attribute

version: str | None = None

The version identifier of the API documentation snapshot.