search

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.68k stars 3.93k forks source link

`aws-cdk-lib.aws_apigatewayv2`: confusing wording for `HttpApi.disableExecuteApiEndpoint` #31729

Closed anentropic closed 1 month ago

anentropic commented 1 month ago

Describe the issue

disableExecuteApiEndpoint?

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.

I think this means if you want to use a custom domain you should set disableExecuteApiEndpoint=true ? I'm pretty sure that's how I would want it to behave.

It is confusing because the wording says "enable this" but the param is called "disable...", so it's unclear if it means to enable the disabling flag, or to enable the thing that the disabling flag disables.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpApi.html#disableexecuteapiendpoint

ashishdhingra commented 1 month ago

Created PR https://github.com/aws/aws-cdk/pull/31734 to make documentation more clearer.

github-actions[bot] commented 1 month ago

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

github-actions[bot] commented 1 month ago

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.