Skip to content

Commit 7e2cbdb

Browse files
AllanZhengYPAllanZhengYP
authored
docs(clients): annotate internal configs and hide internal APIs (#2388)
* feat(clients): annotate internal client configs * docs(clients): add documentation for all resolved config entries * fix(api-reference): group command and IO types correctly * docs(clients): strip docs for internal API or test files
1 parent 597e689 commit 7e2cbdb

File tree

568 files changed

+5006
-1703
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

568 files changed

+5006
-1703
lines changed

‎clients/client-accessanalyzer/AccessAnalyzerClient.ts

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,46 +170,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
170170
/**
171171
* A constructor for a class implementing the @aws-sdk/types.Hash interface
172172
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
173+
* @internal
173174
*/
174175
sha256?: __HashConstructor;
175176

176177
/**
177178
* The function that will be used to convert strings into HTTP endpoints.
179+
* @internal
178180
*/
179181
urlParser?: __UrlParser;
180182

181183
/**
182184
* A function that can calculate the length of a request body.
185+
* @internal
183186
*/
184187
bodyLengthChecker?: (body: any) => number | undefined;
185188

186189
/**
187190
* A function that converts a stream into an array of bytes.
191+
* @internal
188192
*/
189193
streamCollector?: __StreamCollector;
190194

191195
/**
192-
* The function that will be used to convert a base64-encoded string to a byte array
196+
* The function that will be used to convert a base64-encoded string to a byte array.
197+
* @internal
193198
*/
194199
base64Decoder?: __Decoder;
195200

196201
/**
197-
* The function that will be used to convert binary data to a base64-encoded string
202+
* The function that will be used to convert binary data to a base64-encoded string.
203+
* @internal
198204
*/
199205
base64Encoder?: __Encoder;
200206

201207
/**
202-
* The function that will be used to convert a UTF8-encoded string to a byte array
208+
* The function that will be used to convert a UTF8-encoded string to a byte array.
209+
* @internal
203210
*/
204211
utf8Decoder?: __Decoder;
205212

206213
/**
207-
* The function that will be used to convert binary data to a UTF-8 encoded string
214+
* The function that will be used to convert binary data to a UTF-8 encoded string.
215+
* @internal
208216
*/
209217
utf8Encoder?: __Encoder;
210218

211219
/**
212-
* The runtime environment
220+
* The runtime environment.
221+
* @internal
213222
*/
214223
runtime?: string;
215224

@@ -242,11 +251,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
242251

243252
/**
244253
* Default credentials provider; Not available in browser runtime.
254+
* @internal
245255
*/
246256
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
247257

248258
/**
249259
* Fetch related hostname, signing name or signing region with given region.
260+
* @internal
250261
*/
251262
regionInfoProvider?: RegionInfoProvider;
252263

‎clients/client-accessanalyzer/tsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
"outDir": "dist/cjs"
1717
},
1818
"typedocOptions": {
19-
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
19+
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
2020
"excludeNotExported": true,
2121
"excludePrivate": true,
2222
"hideGenerator": true,
2323
"ignoreCompilerErrors": true,
2424
"includeDeclarations": true,
25+
"stripInternal": true,
2526
"readme": "./README.md",
2627
"mode": "file",
2728
"out": "./docs",

‎clients/client-acm-pca/ACMPCAClient.ts

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,46 +170,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
170170
/**
171171
* A constructor for a class implementing the @aws-sdk/types.Hash interface
172172
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
173+
* @internal
173174
*/
174175
sha256?: __HashConstructor;
175176

176177
/**
177178
* The function that will be used to convert strings into HTTP endpoints.
179+
* @internal
178180
*/
179181
urlParser?: __UrlParser;
180182

181183
/**
182184
* A function that can calculate the length of a request body.
185+
* @internal
183186
*/
184187
bodyLengthChecker?: (body: any) => number | undefined;
185188

186189
/**
187190
* A function that converts a stream into an array of bytes.
191+
* @internal
188192
*/
189193
streamCollector?: __StreamCollector;
190194

191195
/**
192-
* The function that will be used to convert a base64-encoded string to a byte array
196+
* The function that will be used to convert a base64-encoded string to a byte array.
197+
* @internal
193198
*/
194199
base64Decoder?: __Decoder;
195200

196201
/**
197-
* The function that will be used to convert binary data to a base64-encoded string
202+
* The function that will be used to convert binary data to a base64-encoded string.
203+
* @internal
198204
*/
199205
base64Encoder?: __Encoder;
200206

201207
/**
202-
* The function that will be used to convert a UTF8-encoded string to a byte array
208+
* The function that will be used to convert a UTF8-encoded string to a byte array.
209+
* @internal
203210
*/
204211
utf8Decoder?: __Decoder;
205212

206213
/**
207-
* The function that will be used to convert binary data to a UTF-8 encoded string
214+
* The function that will be used to convert binary data to a UTF-8 encoded string.
215+
* @internal
208216
*/
209217
utf8Encoder?: __Encoder;
210218

211219
/**
212-
* The runtime environment
220+
* The runtime environment.
221+
* @internal
213222
*/
214223
runtime?: string;
215224

@@ -242,11 +251,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
242251

243252
/**
244253
* Default credentials provider; Not available in browser runtime.
254+
* @internal
245255
*/
246256
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
247257

248258
/**
249259
* Fetch related hostname, signing name or signing region with given region.
260+
* @internal
250261
*/
251262
regionInfoProvider?: RegionInfoProvider;
252263

‎clients/client-acm-pca/tsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
"outDir": "dist/cjs"
1717
},
1818
"typedocOptions": {
19-
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
19+
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
2020
"excludeNotExported": true,
2121
"excludePrivate": true,
2222
"hideGenerator": true,
2323
"ignoreCompilerErrors": true,
2424
"includeDeclarations": true,
25+
"stripInternal": true,
2526
"readme": "./README.md",
2627
"mode": "file",
2728
"out": "./docs",

‎clients/client-acm/ACMClient.ts

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,46 +131,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
131131
/**
132132
* A constructor for a class implementing the @aws-sdk/types.Hash interface
133133
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
134+
* @internal
134135
*/
135136
sha256?: __HashConstructor;
136137

137138
/**
138139
* The function that will be used to convert strings into HTTP endpoints.
140+
* @internal
139141
*/
140142
urlParser?: __UrlParser;
141143

142144
/**
143145
* A function that can calculate the length of a request body.
146+
* @internal
144147
*/
145148
bodyLengthChecker?: (body: any) => number | undefined;
146149

147150
/**
148151
* A function that converts a stream into an array of bytes.
152+
* @internal
149153
*/
150154
streamCollector?: __StreamCollector;
151155

152156
/**
153-
* The function that will be used to convert a base64-encoded string to a byte array
157+
* The function that will be used to convert a base64-encoded string to a byte array.
158+
* @internal
154159
*/
155160
base64Decoder?: __Decoder;
156161

157162
/**
158-
* The function that will be used to convert binary data to a base64-encoded string
163+
* The function that will be used to convert binary data to a base64-encoded string.
164+
* @internal
159165
*/
160166
base64Encoder?: __Encoder;
161167

162168
/**
163-
* The function that will be used to convert a UTF8-encoded string to a byte array
169+
* The function that will be used to convert a UTF8-encoded string to a byte array.
170+
* @internal
164171
*/
165172
utf8Decoder?: __Decoder;
166173

167174
/**
168-
* The function that will be used to convert binary data to a UTF-8 encoded string
175+
* The function that will be used to convert binary data to a UTF-8 encoded string.
176+
* @internal
169177
*/
170178
utf8Encoder?: __Encoder;
171179

172180
/**
173-
* The runtime environment
181+
* The runtime environment.
182+
* @internal
174183
*/
175184
runtime?: string;
176185

@@ -203,11 +212,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
203212

204213
/**
205214
* Default credentials provider; Not available in browser runtime.
215+
* @internal
206216
*/
207217
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
208218

209219
/**
210220
* Fetch related hostname, signing name or signing region with given region.
221+
* @internal
211222
*/
212223
regionInfoProvider?: RegionInfoProvider;
213224

‎clients/client-acm/tsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
"outDir": "dist/cjs"
1717
},
1818
"typedocOptions": {
19-
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
19+
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
2020
"excludeNotExported": true,
2121
"excludePrivate": true,
2222
"hideGenerator": true,
2323
"ignoreCompilerErrors": true,
2424
"includeDeclarations": true,
25+
"stripInternal": true,
2526
"readme": "./README.md",
2627
"mode": "file",
2728
"out": "./docs",

‎clients/client-alexa-for-business/AlexaForBusinessClient.ts

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -458,46 +458,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
458458
/**
459459
* A constructor for a class implementing the @aws-sdk/types.Hash interface
460460
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
461+
* @internal
461462
*/
462463
sha256?: __HashConstructor;
463464

464465
/**
465466
* The function that will be used to convert strings into HTTP endpoints.
467+
* @internal
466468
*/
467469
urlParser?: __UrlParser;
468470

469471
/**
470472
* A function that can calculate the length of a request body.
473+
* @internal
471474
*/
472475
bodyLengthChecker?: (body: any) => number | undefined;
473476

474477
/**
475478
* A function that converts a stream into an array of bytes.
479+
* @internal
476480
*/
477481
streamCollector?: __StreamCollector;
478482

479483
/**
480-
* The function that will be used to convert a base64-encoded string to a byte array
484+
* The function that will be used to convert a base64-encoded string to a byte array.
485+
* @internal
481486
*/
482487
base64Decoder?: __Decoder;
483488

484489
/**
485-
* The function that will be used to convert binary data to a base64-encoded string
490+
* The function that will be used to convert binary data to a base64-encoded string.
491+
* @internal
486492
*/
487493
base64Encoder?: __Encoder;
488494

489495
/**
490-
* The function that will be used to convert a UTF8-encoded string to a byte array
496+
* The function that will be used to convert a UTF8-encoded string to a byte array.
497+
* @internal
491498
*/
492499
utf8Decoder?: __Decoder;
493500

494501
/**
495-
* The function that will be used to convert binary data to a UTF-8 encoded string
502+
* The function that will be used to convert binary data to a UTF-8 encoded string.
503+
* @internal
496504
*/
497505
utf8Encoder?: __Encoder;
498506

499507
/**
500-
* The runtime environment
508+
* The runtime environment.
509+
* @internal
501510
*/
502511
runtime?: string;
503512

@@ -530,11 +539,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
530539

531540
/**
532541
* Default credentials provider; Not available in browser runtime.
542+
* @internal
533543
*/
534544
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
535545

536546
/**
537547
* Fetch related hostname, signing name or signing region with given region.
548+
* @internal
538549
*/
539550
regionInfoProvider?: RegionInfoProvider;
540551

‎clients/client-alexa-for-business/tsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
"outDir": "dist/cjs"
1717
},
1818
"typedocOptions": {
19-
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
19+
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
2020
"excludeNotExported": true,
2121
"excludePrivate": true,
2222
"hideGenerator": true,
2323
"ignoreCompilerErrors": true,
2424
"includeDeclarations": true,
25+
"stripInternal": true,
2526
"readme": "./README.md",
2627
"mode": "file",
2728
"out": "./docs",

0 commit comments

Comments
 (0)