You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::CreateDocumentationVersionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateDocumentationVersionRequest
- Defined in:
- (unknown)
Overview
Note:
When passing CreateDocumentationVersionRequest as input to an Aws::Client method, you can use a vanilla 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
-
#description ⇒ String
A description about the new documentation snapshot.
-
#documentation_version ⇒ String
[Required] The version identifier of the new snapshot.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
-
#stage_name ⇒ String
The stage name to be associated with the new documentation snapshot.
Instance Attribute Details
#description ⇒ String
A description about the new documentation snapshot.
#documentation_version ⇒ String
[Required] The version identifier of the new snapshot.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#stage_name ⇒ String
The stage name to be associated with the new documentation snapshot.