get_documentation_versions¶
Operation¶
get_documentation_versions
¶
get_documentation_versions(request: GetDocumentationVersionsInput | GetDocumentationVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationVersionsInputDict]) -> GetDocumentationVersionsOutput
Gets documentation versions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetDocumentationVersionsInput | GetDocumentationVersionsInputDict | 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[GetDocumentationVersionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDocumentationVersionsOutput
|
An instance of |
get_documentation_versions
async
¶
get_documentation_versions(request: GetDocumentationVersionsInput | GetDocumentationVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationVersionsInputDict]) -> GetDocumentationVersionsOutput
Gets documentation versions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetDocumentationVersionsInput | GetDocumentationVersionsInputDict | 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[GetDocumentationVersionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDocumentationVersionsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetDocumentationVersionsInputDict
¶
Bases: TypedDict
Dictionary form of GetDocumentationVersionsInput.
GetDocumentationVersionsInput
dataclass
¶
Bases: _SerdeShape
Gets the documentation versions of an API.
Attributes¶
limit
class-attribute
instance-attribute
¶
limit: int | None = ...
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
Output¶
GetDocumentationVersionsOutput
dataclass
¶
Bases: _SerdeShape
The collection of documentation snapshots of an API.
Attributes¶
items
class-attribute
instance-attribute
¶
items: list[DocumentationVersion] | None = ...
The current page of elements from this collection.
position
class-attribute
instance-attribute
¶
position: str | None = ...
The current pagination position in the paged result set.
response_metadata
class-attribute
instance-attribute
¶
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.