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

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

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

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The date when the API documentation snapshot is created.

Returns:

  • (Time)

    The date when the API documentation snapshot is created.

#descriptionString

The description of the API documentation snapshot.

Returns:

  • (String)

    The description of the API documentation snapshot.

#versionString

The version identifier of the API documentation snapshot.

Returns:

  • (String)

    The version identifier of the API documentation snapshot.