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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::DocumentationVersion

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

A snapshot of the documentation of an API.

<div class=“remarks” markdown=“1”> Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.

</div>

<div class=“seeAlso” markdown=“1”> [Documenting an API], DocumentationPart, DocumentationVersions </div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_date ⇒ Time

  The date when the API documentation snapshot is created.

• #description ⇒ String

  The description of the API documentation snapshot.

• #version ⇒ String

  The version identifier of the API documentation snapshot.

Instance Attribute Details

#created_date ⇒ Time

The date when the API documentation snapshot is created.

Returns:

• (Time)

# File 'lib/aws-sdk-apigateway/types.rb', line 2508

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

#description ⇒ String

The description of the API documentation snapshot.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2508

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

#version ⇒ String

The version identifier of the API documentation snapshot.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2508

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