AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetDocumentationPartsOutput

import "github.com/aws/aws-sdk-go/service/apigateway"

type GetDocumentationPartsOutput struct { Items []*DocumentationPart `locationName:"item" type:"list"` Position *string `locationName:"position" type:"string"` }

The collection of documentation parts of an API.

Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart

Items

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

Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationParts

Position

Type: *string

Method

GoString

func (s GetDocumentationPartsOutput) GoString() string

GoString returns the string representation

SetItems

func (s *GetDocumentationPartsOutput) SetItems(v []*DocumentationPart) *GetDocumentationPartsOutput

SetItems sets the Items field's value.

SetPosition

func (s *GetDocumentationPartsOutput) SetPosition(v string) *GetDocumentationPartsOutput

SetPosition sets the Position field's value.

String

func (s GetDocumentationPartsOutput) String() string

String returns the string representation

On this page: