get_documentation_parts¶
Operation¶
async
¶
get_documentation_parts(input: GetDocumentationPartsInput, plugins: list[Plugin] | None = None) -> GetDocumentationPartsOutput
Gets documentation parts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDocumentationPartsInput
|
An instance of |
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 |
|---|---|
GetDocumentationPartsOutput
|
An instance of |
Input¶
dataclass
¶
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
Attributes¶
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.
class-attribute
instance-attribute
¶
location_status: LocationStatusType | None = 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.
class-attribute
instance-attribute
¶
name_query: str | None = None
The name of API entities of the to-be-retrieved documentation parts.
class-attribute
instance-attribute
¶
path: str | None = None
The path of API entities of the to-be-retrieved documentation parts.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
type: DocumentationPartType | None = None
The type of API entities of the to-be-retrieved documentation parts.
Output¶
dataclass
¶
The collection of documentation parts of an API.
Attributes¶
class-attribute
instance-attribute
¶
items: list[DocumentationPart] | None = None
The current page of elements from this collection.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.