Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions private/my-local-model/src/commands/GetNumbersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface GetNumbersCommandOutput extends GetNumbersResponse, __MetadataB
* ```javascript
* import { XYZServiceClient, GetNumbersCommand } from "xyz"; // ES Modules import
* // const { XYZServiceClient, GetNumbersCommand } = require("xyz"); // CommonJS import
* // import type { XYZServiceClientConfig } from "xyz";
* const config = {}; // type is XYZServiceClientConfig
* const client = new XYZServiceClient(config);
* const input = { // GetNumbersRequest
* bigDecimal: Number("bigdecimal"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface EmptyInputOutputCommandOutput extends EmptyStructure, __Metadat
* ```javascript
* import { RpcV2ProtocolClient, EmptyInputOutputCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, EmptyInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new EmptyInputOutputCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface Float16CommandOutput extends Float16Output, __MetadataBearer {}
* ```javascript
* import { RpcV2ProtocolClient, Float16Command } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, Float16Command } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new Float16Command(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface FractionalSecondsCommandOutput extends FractionalSecondsOutput,
* ```javascript
* import { RpcV2ProtocolClient, FractionalSecondsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, FractionalSecondsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new FractionalSecondsCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu
* ```javascript
* import { RpcV2ProtocolClient, GreetingWithErrorsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, GreetingWithErrorsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new GreetingWithErrorsCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export interface NoInputOutputCommandOutput extends __MetadataBearer {}
* ```javascript
* import { RpcV2ProtocolClient, NoInputOutputCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, NoInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new NoInputOutputCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface OperationWithDefaultsCommandOutput extends OperationWithDefault
* ```javascript
* import { RpcV2ProtocolClient, OperationWithDefaultsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, OperationWithDefaultsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // OperationWithDefaultsInput
* defaults: { // Defaults
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface OptionalInputOutputCommandOutput extends SimpleStructure, __Met
* ```javascript
* import { RpcV2ProtocolClient, OptionalInputOutputCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, OptionalInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // SimpleStructure
* value: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface RecursiveShapesCommandOutput extends RecursiveShapesInputOutput
* ```javascript
* import { RpcV2ProtocolClient, RecursiveShapesCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, RecursiveShapesCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RecursiveShapesInputOutput
* nested: { // RecursiveShapesInputOutputNested1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export interface RpcV2CborDenseMapsCommandOutput extends RpcV2CborDenseMapsInput
* ```javascript
* import { RpcV2ProtocolClient, RpcV2CborDenseMapsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, RpcV2CborDenseMapsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RpcV2CborDenseMapsInputOutput
* denseStructMap: { // DenseStructMap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ export interface RpcV2CborListsCommandOutput extends RpcV2CborListInputOutput, _
* ```javascript
* import { RpcV2ProtocolClient, RpcV2CborListsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, RpcV2CborListsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RpcV2CborListInputOutput
* stringList: [ // StringList
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface RpcV2CborSparseMapsCommandOutput extends RpcV2CborSparseMapsInp
* ```javascript
* import { RpcV2ProtocolClient, RpcV2CborSparseMapsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, RpcV2CborSparseMapsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RpcV2CborSparseMapsInputOutput
* sparseStructMap: { // SparseStructMap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface SimpleScalarPropertiesCommandOutput extends SimpleScalarStructu
* ```javascript
* import { RpcV2ProtocolClient, SimpleScalarPropertiesCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, SimpleScalarPropertiesCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // SimpleScalarStructure
* trueBooleanValue: true || false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface SparseNullsOperationCommandOutput extends SparseNullsOperationI
* ```javascript
* import { RpcV2ProtocolClient, SparseNullsOperationCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
* // const { RpcV2ProtocolClient, SparseNullsOperationCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // SparseNullsOperationInputOutput
* sparseStringList: [ // SparseStringList
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface EmptyInputOutputCommandOutput extends EmptyStructure, __Metadat
* ```javascript
* import { RpcV2ProtocolClient, EmptyInputOutputCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, EmptyInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new EmptyInputOutputCommand(input);
Expand Down
2 changes: 2 additions & 0 deletions private/smithy-rpcv2-cbor/src/commands/Float16Command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface Float16CommandOutput extends Float16Output, __MetadataBearer {}
* ```javascript
* import { RpcV2ProtocolClient, Float16Command } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, Float16Command } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new Float16Command(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface FractionalSecondsCommandOutput extends FractionalSecondsOutput,
* ```javascript
* import { RpcV2ProtocolClient, FractionalSecondsCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, FractionalSecondsCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new FractionalSecondsCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu
* ```javascript
* import { RpcV2ProtocolClient, GreetingWithErrorsCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, GreetingWithErrorsCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new GreetingWithErrorsCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface NoInputOutputCommandOutput extends __MetadataBearer {}
* ```javascript
* import { RpcV2ProtocolClient, NoInputOutputCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, NoInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = {};
* const command = new NoInputOutputCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface OperationWithDefaultsCommandOutput extends OperationWithDefault
* ```javascript
* import { RpcV2ProtocolClient, OperationWithDefaultsCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, OperationWithDefaultsCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // OperationWithDefaultsInput
* defaults: { // Defaults
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface OptionalInputOutputCommandOutput extends SimpleStructure, __Met
* ```javascript
* import { RpcV2ProtocolClient, OptionalInputOutputCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, OptionalInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // SimpleStructure
* value: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface RecursiveShapesCommandOutput extends RecursiveShapesInputOutput
* ```javascript
* import { RpcV2ProtocolClient, RecursiveShapesCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, RecursiveShapesCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RecursiveShapesInputOutput
* nested: { // RecursiveShapesInputOutputNested1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface RpcV2CborDenseMapsCommandOutput extends RpcV2CborDenseMapsInput
* ```javascript
* import { RpcV2ProtocolClient, RpcV2CborDenseMapsCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, RpcV2CborDenseMapsCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RpcV2CborDenseMapsInputOutput
* denseStructMap: { // DenseStructMap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ export interface RpcV2CborListsCommandOutput extends RpcV2CborListInputOutput, _
* ```javascript
* import { RpcV2ProtocolClient, RpcV2CborListsCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, RpcV2CborListsCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RpcV2CborListInputOutput
* stringList: [ // StringList
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface RpcV2CborSparseMapsCommandOutput extends RpcV2CborSparseMapsInp
* ```javascript
* import { RpcV2ProtocolClient, RpcV2CborSparseMapsCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, RpcV2CborSparseMapsCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // RpcV2CborSparseMapsInputOutput
* sparseStructMap: { // SparseStructMap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface SimpleScalarPropertiesCommandOutput extends SimpleScalarStructu
* ```javascript
* import { RpcV2ProtocolClient, SimpleScalarPropertiesCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, SimpleScalarPropertiesCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // SimpleScalarStructure
* trueBooleanValue: true || false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface SparseNullsOperationCommandOutput extends SparseNullsOperationI
* ```javascript
* import { RpcV2ProtocolClient, SparseNullsOperationCommand } from "@smithy/smithy-rpcv2-cbor"; // ES Modules import
* // const { RpcV2ProtocolClient, SparseNullsOperationCommand } = require("@smithy/smithy-rpcv2-cbor"); // CommonJS import
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor";
* const config = {}; // type is RpcV2ProtocolClientConfig
* const client = new RpcV2ProtocolClient(config);
* const input = { // SparseNullsOperationInputOutput
* sparseStringList: [ // SparseStringList
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ private String getCommandExample(
packageName)
+ String.format("// const { %s, %s } = require(\"%s\"); // CommonJS import%n", serviceName, commandName,
packageName)
+ String.format("// import type { %sConfig } from \"%s\";%n", serviceName, packageName)
+ String.format("const config = {}; // type is %sConfig%n", serviceName)
+ String.format("const client = new %s(config);%n", serviceName)
+ String.format("const input = %s%n",
StructureExampleGenerator.generateStructuralHintDocumentation(
Expand Down
Loading