Api Gateway  >  Operations  >  get_documentation_versions

get_documentation_versions

Operation

get_documentation_versions async

get_documentation_versions(input: GetDocumentationVersionsInput, plugins: list[Plugin] | None = None) -> GetDocumentationVersionsOutput

Gets documentation versions.

Parameters:

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

Input

GetDocumentationVersionsInput dataclass

Gets the documentation versions of an API.

Attributes

limit class-attribute instance-attribute

limit: int | None = None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position class-attribute instance-attribute

position: str | None = None

The current pagination position in the paged result set.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

GetDocumentationVersionsOutput dataclass

The collection of documentation snapshots of an API.

Attributes

items class-attribute instance-attribute

items: list[DocumentationVersion] | None = None

The current page of elements from this collection.

position class-attribute instance-attribute

position: str | None = None

The current pagination position in the paged result set.