Skip to content

GetResourcesRequest

Source code in docs_src/capo_api_gateway/types/get_resources_request.py 
13
14
15
16
17
18
19
20
21
class GetResourcesRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    position: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The current pagination position in the paged result set.</p>"""
    limit: NotRequired["capo_api_gateway.types.nullable_integer.NullableInteger"]
    """<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>"""
    embed: NotRequired["capo_api_gateway.types.list_of_string.ListOfString"]
    """<p>A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.</p>"""

embed instance-attribute 

embed: NotRequired[ListOfString]

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

limit instance-attribute 

limit: NotRequired[NullableInteger]

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position instance-attribute 

position: NotRequired[String]

The current pagination position in the paged result set.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.