Class: Aws::APIGateway::Types::GetDocumentationPartsRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetDocumentationPartsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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
}

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (Integer)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#name_query ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#position ⇒ String

The current pagination position in the paged result set.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3415

class GetDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :type,
  :name_query,
  :path,
  :position,
  :limit,
  :location_status)
  SENSITIVE = []
  include Aws::Structure
end