You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::CreateDocumentationPartRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateDocumentationPartRequest
- Defined in:
- (unknown)
Overview
When passing CreateDocumentationPartRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", # required
location: { # required
type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
path: "String",
method: "String",
status_code: "DocumentationPartLocationStatusCode",
name: "String",
},
properties: "String", # required
}
Creates a new documentation part of a given API.
Instance Attribute Summary collapse
-
#location ⇒ Types::DocumentationPartLocation
[Required] The location of the targeted API entity of the to-be-created documentation part.
-
#properties ⇒ String
[Required] The new documentation content map of the targeted API entity.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
Instance Attribute Details
#location ⇒ Types::DocumentationPartLocation
[Required] The location of the targeted API entity of the to-be-created documentation part.
#properties ⇒ String
[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.