Class: Aws::APIGateway::Types::DocumentationPart
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::DocumentationPart
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
A documentation part for a targeted API entity.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#id ⇒ String
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created. -
#location ⇒ Types::DocumentationPartLocation
The location of the API entity to which the documentation applies.
-
#properties ⇒ String
A content map of API-specific key-value pairs describing the targeted API entity.
Instance Attribute Details
#id ⇒ String
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created.
1686 1687 1688 1689 1690 1691 1692 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1686 class DocumentationPart < Struct.new( :id, :location, :properties) SENSITIVE = [] include Aws::Structure end |
#location ⇒ Types::DocumentationPartLocation
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
1686 1687 1688 1689 1690 1691 1692 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1686 class DocumentationPart < Struct.new( :id, :location, :properties) SENSITIVE = [] include Aws::Structure end |
#properties ⇒ String
A content map of API-specific key-value pairs describing the
targeted API entity. The map must be encoded as a JSON string, e.g.,
"\{ "description": "The API does ..." \}"
. Only
OpenAPI-compliant documentation-related fields from the properties
map are exported and, hence, published as part of the API entity
definitions, while the original documentation parts are exported in
a OpenAPI extension of x-amazon-apigateway-documentation
.
1686 1687 1688 1689 1690 1691 1692 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1686 class DocumentationPart < Struct.new( :id, :location, :properties) SENSITIVE = [] include Aws::Structure end |