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

Class: Aws::APIGateway::Types::UpdateDocumentationPartRequest

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 UpdateDocumentationPartRequest data as a hash:

{
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
}

Updates an existing documentation part of a given API.

Instance Attribute Summary collapse

Instance Attribute Details

#documentation_part_idString

[Required] The identifier of the to-be-updated documentation part.

Returns:

  • (String)


6039
6040
6041
6042
6043
6044
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6039

class UpdateDocumentationPartRequest < Struct.new(
  :rest_api_id,
  :documentation_part_id,
  :patch_operations)
  include Aws::Structure
end

#patch_operationsArray<Types::PatchOperation>

A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



6039
6040
6041
6042
6043
6044
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6039

class UpdateDocumentationPartRequest < Struct.new(
  :rest_api_id,
  :documentation_part_id,
  :patch_operations)
  include Aws::Structure
end

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


6039
6040
6041
6042
6043
6044
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6039

class UpdateDocumentationPartRequest < Struct.new(
  :rest_api_id,
  :documentation_part_id,
  :patch_operations)
  include Aws::Structure
end