-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_GetDocumentationPart.go
199 lines (164 loc) · 6.91 KB
/
api_op_GetDocumentationPart.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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package apigateway
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
// Gets a specified documentation part of a given API.
type GetDocumentationPartInput struct {
_ struct{} `type:"structure"`
// [Required] The string identifier of the associated RestApi.
//
// DocumentationPartId is a required field
DocumentationPartId *string `location:"uri" locationName:"part_id" type:"string" required:"true"`
// [Required] The string identifier of the associated RestApi.
//
// RestApiId is a required field
RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"`
}
// String returns the string representation
func (s GetDocumentationPartInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetDocumentationPartInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "GetDocumentationPartInput"}
if s.DocumentationPartId == nil {
invalidParams.Add(aws.NewErrParamRequired("DocumentationPartId"))
}
if s.RestApiId == nil {
invalidParams.Add(aws.NewErrParamRequired("RestApiId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s GetDocumentationPartInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.DocumentationPartId != nil {
v := *s.DocumentationPartId
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "part_id", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.RestApiId != nil {
v := *s.RestApiId
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "restapi_id", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// 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
type GetDocumentationPartOutput struct {
_ struct{} `type:"structure"`
// The DocumentationPart identifier, generated by API Gateway when the DocumentationPart
// is created.
Id *string `locationName:"id" type:"string"`
// 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.
Location *DocumentationPartLocation `locationName:"location" type:"structure"`
// 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 properties 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.
Properties *string `locationName:"properties" type:"string"`
}
// String returns the string representation
func (s GetDocumentationPartOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s GetDocumentationPartOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.Id != nil {
v := *s.Id
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "id", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.Location != nil {
v := s.Location
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "location", v, metadata)
}
if s.Properties != nil {
v := *s.Properties
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "properties", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
const opGetDocumentationPart = "GetDocumentationPart"
// GetDocumentationPartRequest returns a request value for making API operation for
// Amazon API Gateway.
//
// // Example sending a request using GetDocumentationPartRequest.
// req := client.GetDocumentationPartRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
func (c *Client) GetDocumentationPartRequest(input *GetDocumentationPartInput) GetDocumentationPartRequest {
op := &aws.Operation{
Name: opGetDocumentationPart,
HTTPMethod: "GET",
HTTPPath: "/restapis/{restapi_id}/documentation/parts/{part_id}",
}
if input == nil {
input = &GetDocumentationPartInput{}
}
req := c.newRequest(op, input, &GetDocumentationPartOutput{})
return GetDocumentationPartRequest{Request: req, Input: input, Copy: c.GetDocumentationPartRequest}
}
// GetDocumentationPartRequest is the request type for the
// GetDocumentationPart API operation.
type GetDocumentationPartRequest struct {
*aws.Request
Input *GetDocumentationPartInput
Copy func(*GetDocumentationPartInput) GetDocumentationPartRequest
}
// Send marshals and sends the GetDocumentationPart API request.
func (r GetDocumentationPartRequest) Send(ctx context.Context) (*GetDocumentationPartResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &GetDocumentationPartResponse{
GetDocumentationPartOutput: r.Request.Data.(*GetDocumentationPartOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// GetDocumentationPartResponse is the response type for the
// GetDocumentationPart API operation.
type GetDocumentationPartResponse struct {
*GetDocumentationPartOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// GetDocumentationPart request.
func (r *GetDocumentationPartResponse) SDKResponseMetdata() *aws.Response {
return r.response
}