-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_GetDocumentationParts.go
123 lines (102 loc) · 4.15 KB
/
api_op_GetDocumentationParts.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Code generated by smithy-go-codegen DO NOT EDIT.
package apigateway
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/retry"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/apigateway/types"
smithy "github.com/awslabs/smithy-go"
"github.com/awslabs/smithy-go/middleware"
smithyhttp "github.com/awslabs/smithy-go/transport/http"
)
func (c *Client) GetDocumentationParts(ctx context.Context, params *GetDocumentationPartsInput, optFns ...func(*Options)) (*GetDocumentationPartsOutput, error) {
stack := middleware.NewStack("GetDocumentationParts", smithyhttp.NewStackRequest)
options := c.options.Copy()
for _, fn := range optFns {
fn(&options)
}
addawsRestjson1_serdeOpGetDocumentationPartsMiddlewares(stack)
awsmiddleware.AddRequestInvocationIDMiddleware(stack)
smithyhttp.AddContentLengthMiddleware(stack)
AddResolveEndpointMiddleware(stack, options)
v4.AddComputePayloadSHA256Middleware(stack)
retry.AddRetryMiddlewares(stack, options)
addHTTPSignerV4Middleware(stack, options)
awsmiddleware.AddAttemptClockSkewMiddleware(stack)
addClientUserAgent(stack)
smithyhttp.AddErrorCloseResponseBodyMiddleware(stack)
smithyhttp.AddCloseResponseBodyMiddleware(stack)
addOpGetDocumentationPartsValidationMiddleware(stack)
stack.Initialize.Add(newServiceMetadataMiddleware_opGetDocumentationParts(options.Region), middleware.Before)
addRequestIDRetrieverMiddleware(stack)
addResponseErrorMiddleware(stack)
addAcceptHeader(stack)
for _, fn := range options.APIOptions {
if err := fn(stack); err != nil {
return nil, err
}
}
handler := middleware.DecorateHandler(smithyhttp.NewClientHandler(options.HTTPClient), stack)
result, metadata, err := handler.Handle(ctx, params)
if err != nil {
return nil, &smithy.OperationError{
ServiceID: ServiceID,
OperationName: "GetDocumentationParts",
Err: err,
}
}
out := result.(*GetDocumentationPartsOutput)
out.ResultMetadata = metadata
return out, nil
}
// Gets the documentation parts of an API. The result may be filtered by the type,
// name, or path of API entities (targets).
type GetDocumentationPartsInput struct {
TemplateSkipList []*string
// The type of API entities of the to-be-retrieved documentation parts.
Type types.DocumentationPartType
Title *string
// The name of API entities of the to-be-retrieved documentation parts.
NameQuery *string
// The current pagination position in the paged result set.
Position *string
// The maximum number of returned results per page. The default value is 25 and the
// maximum value is 500.
Limit *int32
Name *string
// The status of the API documentation parts to retrieve. Valid values are
// DOCUMENTED for retrieving DocumentationPart () resources with content and
// UNDOCUMENTED for DocumentationPart () resources without content.
LocationStatus types.LocationStatusType
Template *bool
// The path of API entities of the to-be-retrieved documentation parts.
Path *string
// [Required] The string identifier of the associated RestApi ().
//
// This member is required.
RestApiId *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 ()
type GetDocumentationPartsOutput struct {
// The current page of elements from this collection.
Items []*types.DocumentationPart
// The current pagination position in the paged result set.
Position *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addawsRestjson1_serdeOpGetDocumentationPartsMiddlewares(stack *middleware.Stack) {
stack.Serialize.Add(&awsRestjson1_serializeOpGetDocumentationParts{}, middleware.After)
stack.Deserialize.Add(&awsRestjson1_deserializeOpGetDocumentationParts{}, middleware.After)
}
func newServiceMetadataMiddleware_opGetDocumentationParts(region string) awsmiddleware.RegisterServiceMetadata {
return awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "apigateway",
OperationName: "GetDocumentationParts",
}
}