You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetDocumentationPartsRequestWhen passing GetDocumentationPartsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", type: "API", name_query: "String",
path: "String",
position: "String",
limit: 1,
location_status: "DOCUMENTED", }
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
Instance Attribute Summary collapseThe maximum number of returned results per page.
The status of the API documentation parts to retrieve.
The name of API entities of the to-be-retrieved documentation parts.
The path of API entities of the to-be-retrieved documentation parts.
The current pagination position in the paged result set.
[Required] The string identifier of the associated RestApi.
The type of API entities of the to-be-retrieved documentation parts.
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
#location_status ⇒ StringThe 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.
Possible values:
The name of API entities of the to-be-retrieved documentation parts.
#path ⇒ StringThe path of API entities of the to-be-retrieved documentation parts.
#position ⇒ StringThe current pagination position in the paged result set.
#rest_api_id ⇒ String[Required] The string identifier of the associated RestApi.
#type ⇒ StringThe type of API entities of the to-be-retrieved documentation parts.
Possible values:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4