Skip to content

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

Merged
mergify[bot] merged 4 commits intomainfrom
user/ashdhin/apigatewayv2-HttpApiProps-disableExecuteApiEndpoint-Doc
Oct 14, 2024
Merged

chore(apigatewayv2): rephrased the documentation for HttpApiProps.disableExecuteApiEndpoint to make it more clearer.#31734
mergify[bot] merged 4 commits intomainfrom
user/ashdhin/apigatewayv2-HttpApiProps-disableExecuteApiEndpoint-Doc

Conversation

@ashishdhingra
Copy link
Copy Markdown
Contributor

@ashishdhingra ashishdhingra commented Oct 11, 2024

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

@aws-cdk-automation aws-cdk-automation requested a review from a team October 11, 2024 18:29
@github-actions github-actions bot added the p2 label Oct 11, 2024
@ashishdhingra ashishdhingra mentioned this pull request Oct 11, 2024
Closed
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 11, 2024
@mergify
Copy link
Copy Markdown
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
Copy Markdown
Collaborator

aws-cdk-automation commented Oct 14, 2024

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

@mergify
Copy link
Copy Markdown
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
@mergify mergify bot deleted the user/ashdhin/apigatewayv2-HttpApiProps-disableExecuteApiEndpoint-Doc branch October 14, 2024 18:04
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 14, 2024

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.

Reviewers

1 more reviewer

@moelasmar moelasmar moelasmar approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

contribution/core This is a PR that came from AWS. p2

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

3 participants

@ashishdhingra @aws-cdk-automation @moelasmar