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

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

Overview

A documentation part for a targeted API entity.

<div class=“remarks” markdown=“1”> 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.

</div>

<div class=“seeAlso”> [Documenting an API], DocumentationParts </div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ String

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

Returns:

  • (String) 


1865
1866
1867
1868
1869
1870
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1865

class DocumentationPart < Struct.new(
  :id,
  :location,
  :properties)
  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.

Returns:



1865
1866
1867
1868
1869
1870
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1865

class DocumentationPart < Struct.new(
  :id,
  :location,
  :properties)
  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 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) 


1865
1866
1867
1868
1869
1870
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1865

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