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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::DocumentationPart

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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.

</div>

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

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2339

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.

Returns:

• (Types::DocumentationPartLocation)

# File 'lib/aws-sdk-apigateway/types.rb', line 2339

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 <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 OpenAPI extension of ‘x-amazon-apigateway-documentation`.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2339

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