Class: Aws::APIGateway::Types::CreateDocumentationPartRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::CreateDocumentationPartRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Creates a new documentation part of a given API.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #location ⇒ Types::DocumentationPartLocation

  The location of the targeted API entity of the to-be-created documentation part.

• #properties ⇒ String

  The new documentation content map of the targeted API entity.

• #rest_api_id ⇒ String

  The string identifier of the associated RestApi.

Instance Attribute Details

#location ⇒ Types::DocumentationPartLocation

The location of the targeted API entity of the to-be-created documentation part.

Returns:

• (Types::DocumentationPartLocation)

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

class CreateDocumentationPartRequest < Struct.new(
  :rest_api_id,
  :location,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#properties ⇒ String

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Returns:

• (String)

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

class CreateDocumentationPartRequest < Struct.new(
  :rest_api_id,
  :location,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

The string identifier of the associated RestApi.

Returns:

• (String)

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

class CreateDocumentationPartRequest < Struct.new(
  :rest_api_id,
  :location,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end