class Aws::APIGateway::Types::GetDocumentationPartsRequest

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

@note When making an API call, you may pass GetDocumentationPartsRequest

data as a 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
    }

@!attribute [rw] rest_api_id

\[Required\] The string identifier of the associated RestApi.
@return [String]

@!attribute [rw] type

The type of API entities of the to-be-retrieved documentation parts.
@return [String]

@!attribute [rw] name_query

The name of API entities of the to-be-retrieved documentation parts.
@return [String]

@!attribute [rw] path

The path of API entities of the to-be-retrieved documentation parts.
@return [String]

@!attribute [rw] position

The current pagination position in the paged result set.
@return [String]

@!attribute [rw] limit

The maximum number of returned results per page. The default value
is 25 and the maximum value is 500.
@return [Integer]

@!attribute [rw] location_status

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.
@return [String]

Constants

SENSITIVE