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

Class: Aws::APIGateway::Types::UpdateDocumentationVersionRequest

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

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

Updates an existing documentation version of an API.

Instance Attribute Summary collapse

Instance Attribute Details

#documentation_versionString

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

Returns:

  • (String)


6690
6691
6692
6693
6694
6695
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6690

class UpdateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :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:



6690
6691
6692
6693
6694
6695
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6690

class UpdateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :patch_operations)
  include Aws::Structure
end

#rest_api_idString

[Required] The string identifier of the associated RestApi..

Returns:

  • (String)


6690
6691
6692
6693
6694
6695
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6690

class UpdateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :patch_operations)
  include Aws::Structure
end