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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Creates a new documentation part of a given API.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#locationTypes::DocumentationPartLocation

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



739
740
741
742
743
744
745
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 739

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

#propertiesString

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)


739
740
741
742
743
744
745
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 739

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


739
740
741
742
743
744
745
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 739

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