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

chore(apigatewayv2): rephrased the documentation for HttpApiProps.disableExecuteApiEndpoint to make it more clearer. #31734

Conversation

ashishdhingra
Copy link
Contributor

Issue # (if applicable)

Closes #31729.

Reason for this change

The current documentation for disableExecuteApiEndpoint at HttpApi 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 forDisableExecuteApiEndpoint at AWS::ApiGatewayV2::Api.

Description of how you validated changes

N/A

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Copy link
Contributor

mergify bot commented Oct 14, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: d115e0e
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

mergify bot commented Oct 14, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 1db9be7 into main Oct 14, 2024
12 checks passed
@mergify mergify bot deleted the user/ashdhin/apigatewayv2-HttpApiProps-disableExecuteApiEndpoint-Doc branch October 14, 2024 18:04
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
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-cdk-lib.aws_apigatewayv2: confusing wording for HttpApi.disableExecuteApiEndpoint
3 participants