get_documentation_parts¶
Operation¶
get_documentation_parts
¶
get_documentation_parts(request: GetDocumentationPartsInput | GetDocumentationPartsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationPartsInputDict]) -> GetDocumentationPartsOutput
Gets documentation parts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetDocumentationPartsInput | GetDocumentationPartsInputDict | 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[GetDocumentationPartsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDocumentationPartsOutput
|
An instance of |
get_documentation_parts
async
¶
get_documentation_parts(request: GetDocumentationPartsInput | GetDocumentationPartsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDocumentationPartsInputDict]) -> GetDocumentationPartsOutput
Gets documentation parts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetDocumentationPartsInput | GetDocumentationPartsInputDict | 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[GetDocumentationPartsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDocumentationPartsOutput
|
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.
GetDocumentationPartsInputDict
¶
Bases: TypedDict
Dictionary form of GetDocumentationPartsInput.
Attributes¶
limit
instance-attribute
¶
limit: int | None
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
location_status
instance-attribute
¶
location_status: str | None
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED for retrieving DocumentationPart resources with content and
UNDOCUMENTED for DocumentationPart resources without content.
name_query
instance-attribute
¶
name_query: str | None
The name of API entities of the to-be-retrieved documentation parts.
path
instance-attribute
¶
path: str | None
The path of API entities of the to-be-retrieved documentation parts.
position
instance-attribute
¶
position: str | None
The current pagination position in the paged result set.
rest_api_id
instance-attribute
¶
The string identifier of the associated RestApi.
GetDocumentationPartsInput
dataclass
¶
Bases: _SerdeShape
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
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.
location_status
class-attribute
instance-attribute
¶
location_status: str | None = ...
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED for retrieving DocumentationPart resources with content and
UNDOCUMENTED for DocumentationPart resources without content.
name_query
class-attribute
instance-attribute
¶
name_query: str | None = ...
The name of API entities of the to-be-retrieved documentation parts.
path
class-attribute
instance-attribute
¶
path: str | None = ...
The path of API entities of the to-be-retrieved documentation parts.
position
class-attribute
instance-attribute
¶
position: str | None = ...
The current pagination position in the paged result set.
Output¶
GetDocumentationPartsOutput
dataclass
¶
Bases: _SerdeShape
The collection of documentation parts of an API.
Attributes¶
items
class-attribute
instance-attribute
¶
items: list[DocumentationPart] | 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.