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

Class: Aws::APIGateway::Types::DocumentationVersion

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

Overview

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
[Documenting an API][1], DocumentationPart, DocumentationVersions

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The date when the API documentation snapshot is created.

Returns:

  • (Time)


1960
1961
1962
1963
1964
1965
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1960

class DocumentationVersion < Struct.new(
  :version,
  :created_date,
  :description)
  include Aws::Structure
end

#descriptionString

The description of the API documentation snapshot.

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1960

class DocumentationVersion < Struct.new(
  :version,
  :created_date,
  :description)
  include Aws::Structure
end

#versionString

The version identifier of the API documentation snapshot.

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1960

class DocumentationVersion < Struct.new(
  :version,
  :created_date,
  :description)
  include Aws::Structure
end