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

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

Overview

Note:

When making an API call, you may pass CreateDocumentationPartRequest data as a hash:

{
  rest_api_id: "String", # required
  location: { # required
    type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
    path: "String",
    method: "String",
    status_code: "DocumentationPartLocationStatusCode",
    name: "String",
  },
  properties: "String", # required
}

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.


850
851
852
853
854
855
856
# File 'lib/aws-sdk-apigateway/types.rb', line 850

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)

850
851
852
853
854
855
856
# File 'lib/aws-sdk-apigateway/types.rb', line 850

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)

850
851
852
853
854
855
856
# File 'lib/aws-sdk-apigateway/types.rb', line 850

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