From 07533e57f5b25ca10d23e9f0f38917d636e08128 Mon Sep 17 00:00:00 2001 From: John Lwin Date: Thu, 30 Jan 2025 14:29:17 -0800 Subject: [PATCH 1/2] feat(docs): add client config option reference --- .../amazon/smithy/typescript/codegen/CommandGenerator.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java index 38968e2fdd4..329c9643c80 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java @@ -254,7 +254,7 @@ private String getCommandExample(String serviceName, String configName, String c packageName) + String.format("// const { %s, %s } = require(\"%s\"); // CommonJS import%n", serviceName, commandName, packageName) - + String.format("const client = new %s(config);%n", serviceName) + + String.format("const client = new %s(config); // See AWS SDK config options: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.html%n", serviceName) + String.format("const input = %s%n", StructureExampleGenerator.generateStructuralHintDocumentation( model.getShape(operation.getInputShape()).get(), model, false, true)) From fa86b5b1db87894ada47bb80c75d50dfcf0cfb24 Mon Sep 17 00:00:00 2001 From: John Lwin Date: Fri, 31 Jan 2025 11:14:41 -0800 Subject: [PATCH 2/2] move comment above client config --- .../amazon/smithy/typescript/codegen/CommandGenerator.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java index 329c9643c80..d262601efd2 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java @@ -254,7 +254,8 @@ private String getCommandExample(String serviceName, String configName, String c packageName) + String.format("// const { %s, %s } = require(\"%s\"); // CommonJS import%n", serviceName, commandName, packageName) - + String.format("const client = new %s(config); // See AWS SDK config options: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.html%n", serviceName) + + "// See AWS SDK config options: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.html\n" + + String.format("const client = new %s(config);%n", serviceName) + String.format("const input = %s%n", StructureExampleGenerator.generateStructuralHintDocumentation( model.getShape(operation.getInputShape()).get(), model, false, true))