Skip to content

Commit

Permalink
chore(apigatewayv2): rephrased the documentation for HttpApiProps.dis…
Browse files Browse the repository at this point in the history
…ableExecuteApiEndpoint 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*
  • Loading branch information
ashishdhingra authored Oct 14, 2024
1 parent edd031d commit 1db9be7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-apigatewayv2/lib/http/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 1db9be7

Please sign in to comment.