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

Class: Aws::APIGateway::Types::CreateDocumentationVersionRequest

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

{
  rest_api_id: "String", # required
  documentation_version: "String", # required
  stage_name: "String",
  description: "String",
}

Creates a new documentation version of a given API.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description about the new documentation snapshot.

Returns:

  • (String)


844
845
846
847
848
849
850
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 844

class CreateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :stage_name,
  :description)
  include Aws::Structure
end

#documentation_versionString

[Required] The version identifier of the new snapshot.

Returns:

  • (String)


844
845
846
847
848
849
850
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 844

class CreateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :stage_name,
  :description)
  include Aws::Structure
end

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


844
845
846
847
848
849
850
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 844

class CreateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :stage_name,
  :description)
  include Aws::Structure
end

#stage_nameString

The stage name to be associated with the new documentation snapshot.

Returns:

  • (String)


844
845
846
847
848
849
850
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 844

class CreateDocumentationVersionRequest < Struct.new(
  :rest_api_id,
  :documentation_version,
  :stage_name,
  :description)
  include Aws::Structure
end