Skip to content

strip internal API, endpoint and test files from API reference #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2021
Merged

strip internal API, endpoint and test files from API reference #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d107ab
mark clients internal configs
AllanZhengYP May 9, 2021
103b438
docs: strip internal API, endpoint and test files in reference
AllanZhengYP May 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions ...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/ServiceGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,37 +213,46 @@ private void generateClientDefaults() {

writer.addImport("HashConstructor", "__HashConstructor", "@aws-sdk/types");
writer.writeDocs("A constructor for a class implementing the @aws-sdk/types.Hash interface \n"
+ "that computes the SHA-256 HMAC or checksum of a string or binary buffer.");
+ "that computes the SHA-256 HMAC or checksum of a string or binary buffer.\n"
+ "@internal");
writer.write("sha256?: __HashConstructor;\n");

writer.addImport("UrlParser", "__UrlParser", "@aws-sdk/types");
writer.writeDocs("The function that will be used to convert strings into HTTP endpoints.");
writer.writeDocs("The function that will be used to convert strings into HTTP endpoints.\n"
+ "@internal");
writer.write("urlParser?: __UrlParser;\n");

writer.writeDocs("A function that can calculate the length of a request body.");
writer.writeDocs("A function that can calculate the length of a request body.\n"
+ "@internal");
writer.write("bodyLengthChecker?: (body: any) => number | undefined;\n");

writer.addImport("StreamCollector", "__StreamCollector", "@aws-sdk/types");
writer.writeDocs("A function that converts a stream into an array of bytes.");
writer.writeDocs("A function that converts a stream into an array of bytes.\n"
+ "@internal");
writer.write("streamCollector?: __StreamCollector;\n");

// Note: Encoder and Decoder are both used for base64 and UTF.
writer.addImport("Encoder", "__Encoder", "@aws-sdk/types");
writer.addImport("Decoder", "__Decoder", "@aws-sdk/types");

writer.writeDocs("The function that will be used to convert a base64-encoded string to a byte array");
writer.writeDocs("The function that will be used to convert a base64-encoded string to a byte array.\n"
+ "@internal");
writer.write("base64Decoder?: __Decoder;\n");

writer.writeDocs("The function that will be used to convert binary data to a base64-encoded string");
writer.writeDocs("The function that will be used to convert binary data to a base64-encoded string.\n"
+ "@internal");
writer.write("base64Encoder?: __Encoder;\n");

writer.writeDocs("The function that will be used to convert a UTF8-encoded string to a byte array");
writer.writeDocs("The function that will be used to convert a UTF8-encoded string to a byte array.\n"
+ "@internal");
writer.write("utf8Decoder?: __Decoder;\n");

writer.writeDocs("The function that will be used to convert binary data to a UTF-8 encoded string");
writer.writeDocs("The function that will be used to convert binary data to a UTF-8 encoded string.\n"
+ "@internal");
writer.write("utf8Encoder?: __Encoder;\n");

writer.writeDocs("The runtime environment");
writer.writeDocs("The runtime environment.\n"
+ "@internal");
writer.write("runtime?: string;\n");

writer.writeDocs("Disable dyanamically changing the endpoint of the client based on the hostPrefix \n"
Expand Down
7 changes: 4 additions & 3 deletions ...script-codegen/src/main/resources/software/amazon/smithy/typescript/codegen/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@
"exclude": [
"**/node_modules/**",
"**/*.spec.ts",
"./protocols/*.ts",
"./e2e/*.ts",
"./endpoints.ts"
"**/protocols/*.ts",
"**/e2e/*.ts",
"**/endpoints.ts"
],
"excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
"includeDeclarations": true,
"stripInternal": true,
"readme": "./README.md",
"mode": "file",
"out": "./docs",
Expand Down