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
show all
Defined in:
(unknown)

Overview

Note:

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,
}

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

Instance Attribute Details

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)

    The maximum number of returned results per page.

#name_queryString

The name of API entities of the to-be-retrieved documentation parts.

Returns:

  • (String)

    The name of API entities of the to-be-retrieved documentation parts.

#pathString

The path of API entities of the to-be-retrieved documentation parts.

Returns:

  • (String)

    The path of API entities of the to-be-retrieved documentation parts.

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)

    The current pagination position in the paged result set.

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)

    [Required] The string identifier of the associated RestApi.

#typeString

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

Returns:

  • (String)

    The type of API entities of the to-be-retrieved documentation parts.