Method: Aws::APIGateway::Types::DocumentationPart#properties

Defined in:
lib/aws-sdk-apigateway/types.rb

#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 Swagger-compliant documentation-related fields from the <literal>properties</literal>

map are exported and, hence, published as part of the API entity

definitions, while the original documentation parts are exported in a Swagger extension of ‘x-amazon-apigateway-documentation`.

Returns:

  • (String) 

2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2116

class DocumentationPart < Struct.new(
  :id,
  :location,
  :properties)
  include Aws::Structure
end