You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::DocumentationPart

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

A documentation part for a targeted API entity.

A documentation part consists of a content map (`properties`) and a target (`location`). The target specifies an API entity to which the documentation content applies. The supported API entity types are `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`. Valid `location` fields depend on the API entity type. All valid fields are not required. The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
[Documenting an API][1], DocumentationParts

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1795

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

#locationTypes::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.



1795
1796
1797
1798
1799
1800
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1795

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

#propertiesString

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 properties

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)


1795
1796
1797
1798
1799
1800
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1795

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