You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetDocumentationPartsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetDocumentationPartsRequest
- Defined in:
- (unknown)
Overview
When passing GetDocumentationPartsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", # required
type: "API", # accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
name_query: "String",
path: "String",
position: "String",
limit: 1,
location_status: "DOCUMENTED", # accepts DOCUMENTED, UNDOCUMENTED
}
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 collapse
-
#limit ⇒ Integer
The maximum number of returned results per page.
-
#location_status ⇒ String
The status of the API documentation parts to retrieve.
-
#name_query ⇒ String
The name of API entities of the to-be-retrieved documentation parts.
-
#path ⇒ String
The path of API entities of the to-be-retrieved documentation parts.
-
#position ⇒ String
The current pagination position in the paged result set.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
-
#type ⇒ String
The type of API entities of the to-be-retrieved documentation parts.
Instance Attribute Details
#limit ⇒ Integer
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
#location_status ⇒ String
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.
Possible values:
- DOCUMENTED
- UNDOCUMENTED
#name_query ⇒ String
The name of API entities of the to-be-retrieved documentation parts.
#path ⇒ String
The path of API entities of the to-be-retrieved documentation parts.
#position ⇒ String
The current pagination position in the paged result set.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#type ⇒ String
The type of API entities of the to-be-retrieved documentation parts.
Possible values:
- API
- AUTHORIZER
- MODEL
- RESOURCE
- METHOD
- PATH_PARAMETER
- QUERY_PARAMETER
- REQUEST_HEADER
- REQUEST_BODY
- RESPONSE
- RESPONSE_HEADER
- RESPONSE_BODY