get_rest_apis¶
Operation¶
get_rest_apis
¶
get_rest_apis(request: GetRestApisInput | GetRestApisInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRestApisInputDict]) -> GetRestApisOutput
Lists the RestApis resources for your collection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetRestApisInput | GetRestApisInputDict | 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[GetRestApisInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetRestApisOutput
|
An instance of |
get_rest_apis
async
¶
get_rest_apis(request: GetRestApisInput | GetRestApisInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRestApisInputDict]) -> GetRestApisOutput
Lists the RestApis resources for your collection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetRestApisInput | GetRestApisInputDict | 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[GetRestApisInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetRestApisOutput
|
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.
GetRestApisInput
dataclass
¶
Output¶
GetRestApisOutput
dataclass
¶
Bases: _SerdeShape
Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
Attributes¶
items
class-attribute
instance-attribute
¶
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.