From 1db9be704126fe72950addf0d42e87178919219d Mon Sep 17 00:00:00 2001 From: Ashish Dhingra <67916761+ashishdhingra@users.noreply.github.com> Date: Mon, 14 Oct 2024 11:04:34 -0700 Subject: [PATCH] chore(apigatewayv2): rephrased the documentation for HttpApiProps.disableExecuteApiEndpoint to make it more clearer. (#31734) ### Issue # (if applicable) Closes #31729. ### Reason for this change The current documentation for `disableExecuteApiEndpoint` at [HttpApi](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpApi.html#disableexecuteapiendpoint) is confusing. It states that: ``` Type: boolean (optional, default: false execute-api endpoint enabled.) Specifies whether clients can invoke your API using the default endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. Enable this if you would like clients to use your custom domain name. ``` ### Description of changes Rephrased the documentation for `HttpApiProps.disableExecuteApiEndpoint` to make it more clearer. Refer documentation for`DisableExecuteApiEndpoint` at [AWS::ApiGatewayV2::Api](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint). ### Description of how you validated changes N/A ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts b/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts index 53437c47a5db3..7a7dde32667fc 100644 --- a/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts +++ b/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts @@ -140,8 +140,8 @@ export interface HttpApiProps { /** * Specifies whether clients can invoke your API using the default endpoint. * By default, clients can invoke your API with the default - * `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. Enable - * this if you would like clients to use your custom domain name. + * `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. Set this to + * true if you would like clients to use your custom domain name. * @default false execute-api endpoint enabled. */ readonly disableExecuteApiEndpoint?: boolean;