You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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).

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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

#location_statusString

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)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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

#name_queryString

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

Returns:

  • (String)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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

#pathString

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

Returns:

  • (String)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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

#typeString

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

Returns:

  • (String)


3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3063

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