Skip to content

get_documentation_version

Operation

get_documentation_version

get_documentation_version(request: GetDocumentationVersionInput | GetDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationVersionInputDict]) -> GetDocumentationVersionOutput

Gets a documentation version.

Parameters:

Name Type Description Default
request GetDocumentationVersionInput | GetDocumentationVersionInputDict | 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[GetDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDocumentationVersionOutput

An instance of GetDocumentationVersionOutput.

get_documentation_version async

get_documentation_version(request: GetDocumentationVersionInput | GetDocumentationVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationVersionInputDict]) -> GetDocumentationVersionOutput

Gets a documentation version.

Parameters:

Name Type Description Default
request GetDocumentationVersionInput | GetDocumentationVersionInputDict | 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[GetDocumentationVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDocumentationVersionOutput

An instance of GetDocumentationVersionOutput.

Input

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

GetDocumentationVersionInputDict

Bases: TypedDict

Dictionary form of GetDocumentationVersionInput.

Attributes

documentation_version instance-attribute
documentation_version: Required[str]

The version identifier of the to-be-retrieved documentation snapshot.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetDocumentationVersionInput dataclass

Bases: _SerdeShape

Gets a documentation snapshot of an API.

Attributes

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

The version identifier of the to-be-retrieved documentation snapshot.

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

The string identifier of the associated RestApi.

Output

GetDocumentationVersionOutput 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.