class
Amazonite::ApiGateway::CreateDocumentationPartRequest
- Amazonite::ApiGateway::CreateDocumentationPartRequest
- Reference
- Object
Overview
Creates a new documentation part of a given API.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/create_documentation_part_request.crConstructors
- .new(rest_api_id : String, location : DocumentationPartLocation, properties : String)
- .new(pull : JSON::PullParser)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#location : DocumentationPartLocation
The location of the targeted API entity of the to-be-created documentation part.
-
#location=(location : DocumentationPartLocation)
The location of the targeted API entity of the to-be-created documentation part.
-
#properties : String
The new documentation content map of the targeted API entity.
-
#properties=(properties : String)
The new documentation content map of the targeted API entity.
-
#rest_api_id : String
The string identifier of the associated RestApi.
-
#rest_api_id=(rest_api_id : String)
The string identifier of the associated RestApi.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The location of the targeted API entity of the to-be-created documentation part.
The location of the targeted API entity of the to-be-created documentation part.
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.
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.