Class: Aws::APIGateway::Types::DocumentationPartIds

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::DocumentationPartIds

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

A collection of the imported DocumentationPart identifiers.

<div class=“remarks”> This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway </div>

<div class=“seeAlso” markdown=“1”> [Documenting an API], [documentationpart:import], DocumentationPart </div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html [2]: docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ids ⇒ Array<String>

  A list of the returned documentation part identifiers.

• #warnings ⇒ Array<String>

  A list of warning messages reported during import of documentation parts.

Instance Attribute Details

#ids ⇒ Array<String>

A list of the returned documentation part identifiers.

Returns:

• (Array<String>)

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

class DocumentationPartIds < Struct.new(
  :ids,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warnings ⇒ Array<String>

A list of warning messages reported during import of documentation parts.

Returns:

• (Array<String>)

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

class DocumentationPartIds < Struct.new(
  :ids,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end