docs(client-api-gateway): Documentation updates for Amazon API Gateway

Author: awstools

clients/client-api-gateway/src/APIGateway.ts

@@ -23,8 +23,7 @@ export interface CreateApiKeyCommandInput extends CreateApiKeyRequest {}
 export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {}
 
 /**
- * <p>Create an <a>ApiKey</a> resource. </p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html">AWS CLI</a></div>
+ * <p>Create an ApiKey resource. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateApiKeyCommand.ts

@@ -23,8 +23,7 @@ export interface CreateAuthorizerCommandInput extends CreateAuthorizerRequest {}
 export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBearer {}
 
 /**
- * <p>Adds a new <a>Authorizer</a> resource to an existing <a>RestApi</a> resource.</p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html">AWS CLI</a></div>
+ * <p>Adds a new Authorizer resource to an existing RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateAuthorizerCommand.ts

@@ -23,7 +23,7 @@ export interface CreateBasePathMappingCommandInput extends CreateBasePathMapping
 export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {}
 
 /**
- * <p>Creates a new <a>BasePathMapping</a> resource.</p>
+ * <p>Creates a new BasePathMapping resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateBasePathMappingCommand.ts

@@ -23,7 +23,7 @@ export interface CreateDeploymentCommandInput extends CreateDeploymentRequest {}
 export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBearer {}
 
 /**
- * <p>Creates a <a>Deployment</a> resource, which makes a specified <a>RestApi</a> callable over the internet.</p>
+ * <p>Creates a Deployment resource, which makes a specified RestApi callable over the internet.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateDeploymentCommand.ts

@@ -22,6 +22,23 @@ import {
 export interface CreateDocumentationPartCommandInput extends CreateDocumentationPartRequest {}
 export interface CreateDocumentationPartCommandOutput extends DocumentationPart, __MetadataBearer {}
 
+/**
+ * <p>Creates a documentation part.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, CreateDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, CreateDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new CreateDocumentationPartCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateDocumentationPartCommandInput} for command's `input` shape.
+ * @see {@link CreateDocumentationPartCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export class CreateDocumentationPartCommand extends $Command<
   CreateDocumentationPartCommandInput,
   CreateDocumentationPartCommandOutput,

clients/client-api-gateway/src/commands/CreateDocumentationPartCommand.ts

@@ -22,6 +22,23 @@ import {
 export interface CreateDocumentationVersionCommandInput extends CreateDocumentationVersionRequest {}
 export interface CreateDocumentationVersionCommandOutput extends DocumentationVersion, __MetadataBearer {}
 
+/**
+ * <p>Creates a documentation version</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, CreateDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, CreateDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new CreateDocumentationVersionCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateDocumentationVersionCommandInput} for command's `input` shape.
+ * @see {@link CreateDocumentationVersionCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export class CreateDocumentationVersionCommand extends $Command<
   CreateDocumentationVersionCommandInput,
   CreateDocumentationVersionCommandOutput,

clients/client-api-gateway/src/commands/CreateDocumentationVersionCommand.ts

@@ -23,7 +23,7 @@ export interface CreateModelCommandInput extends CreateModelRequest {}
 export interface CreateModelCommandOutput extends Model, __MetadataBearer {}
 
 /**
- * <p>Adds a new <a>Model</a> resource to an existing <a>RestApi</a> resource.</p>
+ * <p>Adds a new Model resource to an existing RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateModelCommand.ts

@@ -23,7 +23,7 @@ export interface CreateRequestValidatorCommandInput extends CreateRequestValidat
 export interface CreateRequestValidatorCommandOutput extends RequestValidator, __MetadataBearer {}
 
 /**
- * <p>Creates a <a>ReqeustValidator</a> of a given <a>RestApi</a>.</p>
+ * <p>Creates a RequestValidator of a given RestApi.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateRequestValidatorCommand.ts

@@ -23,7 +23,7 @@ export interface CreateResourceCommandInput extends CreateResourceRequest {}
 export interface CreateResourceCommandOutput extends Resource, __MetadataBearer {}
 
 /**
- * <p>Creates a <a>Resource</a> resource.</p>
+ * <p>Creates a Resource resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript