Skip to content

docs(apigateway): fix doc of Vary header for allowOrigins#33519

Merged
mergify[bot] merged 2 commits intoaws:mainfrom
go-to-k:apigw-allow-origins-doc
Feb 20, 2025
Merged

docs(apigateway): fix doc of Vary header for allowOrigins#33519
mergify[bot] merged 2 commits intoaws:mainfrom
go-to-k:apigw-allow-origins-doc

Conversation

@go-to-k
Copy link
Copy Markdown
Contributor

@go-to-k go-to-k commented Feb 20, 2025

Issue # (if applicable)

Reason for this change

The doc of Vary header for allowOrigins seems to be wrong. It will be included if it is not Cors.ALL_ORIGINS.

If Cors.ALL_ORIGINS is specified, the Vary: Origin response header will also be included.

see:

https://github.com/go-to-k/aws-cdk/blob/9154927fa0959238c4ddf9ba807cc912fa05a5e6/packages/aws-cdk-lib/aws-apigateway/lib/resource.ts#L224

Description of changes

Change to:

If specific origins are specified (not Cors.ALL_ORIGINS), the Vary: Origin response header will also be included.

Describe any new or updated permissions being added

Description of how you validated changes

Checklist


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

@github-actions github-actions bot added the p2 label Feb 20, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team February 20, 2025 09:48
@github-actions github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Feb 20, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.16%. Comparing base (be3bce3) to head (d4d6087).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33519   +/-   ##
=======================================
  Coverage   82.16%   82.16%           
=======================================
  Files         119      119           
  Lines        6857     6857           
  Branches     1157     1157           
=======================================
  Hits         5634     5634           
  Misses       1120     1120           
  Partials      103      103           
Flag Coverage Δ
suite.unit 82.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk ∅ <ø> (∅)
packages/aws-cdk-lib/core 82.16% <ø> (ø)

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 20, 2025
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Feb 20, 2025

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 CodeBuild CI Report

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

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

@mergify mergify bot merged commit 8728d5b into aws:main Feb 20, 2025
20 checks passed
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Feb 20, 2025

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).

@github-actions
Copy link
Copy Markdown
Contributor

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 Feb 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants