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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateDocumentationVersionRequest as input to an Aws::Client method, you can use a vanilla 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)

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

#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:

  • (Array<Types::PatchOperation>)

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

#rest_api_idString

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

Returns:

  • (String)

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