Gets documentation parts.
See https://www.paws-r-sdk.com/docs/apigateway_get_documentation_parts/ for full documentation.
Usage
apigateway_get_documentation_parts(
restApiId,
type = NULL,
nameQuery = NULL,
path = NULL,
position = NULL,
limit = NULL,
locationStatus = NULL
)Arguments
- restApiId
[required] The string identifier of the associated RestApi.
- type
The type of API entities of the to-be-retrieved documentation parts.
- nameQuery
The name of API entities of the to-be-retrieved documentation parts.
- path
The path of API entities of the to-be-retrieved documentation parts.
- position
The current pagination position in the paged result set.
- limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- locationStatus
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTEDfor retrieving DocumentationPart resources with content andUNDOCUMENTEDfor DocumentationPart resources without content.