Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
anentropic opened this issue Oct 11, 2024 · 3 comments · Fixed by #31734
Closed
Assignees
Labels
@aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@anentropic
Copy link

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

@anentropic anentropic added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Oct 11, 2024
@github-actions github-actions bot added the @aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 label Oct 11, 2024
@ashishdhingra ashishdhingra self-assigned this Oct 11, 2024
@ashishdhingra ashishdhingra added p2 investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Oct 11, 2024
@ashishdhingra
Copy link
Contributor

Created PR #31734 to make documentation more clearer.

@ashishdhingra ashishdhingra added effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Oct 11, 2024
@mergify mergify bot closed this as completed in #31734 Oct 14, 2024
@mergify mergify bot closed this as completed in 1db9be7 Oct 14, 2024
Copy link

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.

1 similar comment
Copy link

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 github-actions bot locked as resolved and limited conversation to collaborators Oct 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
@aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
2 participants