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.

ImportDocumentationPartsInput

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

type ImportDocumentationPartsInput struct { Body []byte `locationName:"body" type:"blob" required:"true"` FailOnWarnings *bool `location:"querystring" locationName:"failonwarnings" type:"boolean"` Mode *string `location:"querystring" locationName:"mode" type:"string" enum:"PutMode"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` }

Import documentation parts from an external (e.g., OpenAPI) definition file.

Body

Type: []byte

[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Body is a required field

FailOnWarnings

Type: *bool

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

Mode

Type: *string

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

Method

GoString

func (s ImportDocumentationPartsInput) GoString() string

GoString returns the string representation

SetBody

func (s *ImportDocumentationPartsInput) SetBody(v []byte) *ImportDocumentationPartsInput

SetBody sets the Body field's value.

SetFailOnWarnings

func (s *ImportDocumentationPartsInput) SetFailOnWarnings(v bool) *ImportDocumentationPartsInput

SetFailOnWarnings sets the FailOnWarnings field's value.

SetMode

func (s *ImportDocumentationPartsInput) SetMode(v string) *ImportDocumentationPartsInput

SetMode sets the Mode field's value.

SetRestApiId

func (s *ImportDocumentationPartsInput) SetRestApiId(v string) *ImportDocumentationPartsInput

SetRestApiId sets the RestApiId field's value.

String

func (s ImportDocumentationPartsInput) String() string

String returns the string representation

Validate

func (s *ImportDocumentationPartsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: