aws-cdk icon indicating copy to clipboard operation
aws-cdk copied to clipboard

docs(apigateway): update `RateLimitedApiKey` example code

Open akagire opened this issue 1 year ago • 1 comments

Issue # (if applicable)

N/A

Reason for this change

RateLimitedApiKey provides associate with provisioned api key and usage plan. When specify stages, it expects associate with provisioned usage plan and specified stages.

But current behavior did not associate with provisioned usage plan and specified stages but also gives stage like current documents example code.

Considering the context in which RateLimitedApiKey is implemented, it makes sense to associate with provisioned usage plan and specified stages.

Description of changes

Changed sample code to use apiStages instead of stages as get expected behavior.

Checklist


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

akagire avatar Sep 19 '24 03:09 akagire

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[bot] avatar Feb 10 '25 18:02 mergify[bot]

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[bot] avatar Feb 10 '25 21:02 mergify[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 80.92%. Comparing base (9b178c1) to head (b8d570d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #31490   +/-   ##
=======================================
  Coverage   80.92%   80.92%           
=======================================
  Files         236      236           
  Lines       14256    14256           
  Branches     2491     2491           
=======================================
  Hits        11537    11537           
  Misses       2434     2434           
  Partials      285      285           
Flag Coverage Δ
suite.unit 80.92% <ø> (ø)

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

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

codecov[bot] avatar Feb 10 '25 21:02 codecov[bot]

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

mergify[bot] avatar Feb 10 '25 22:02 mergify[bot]

@mergifyio update

paulhcsun avatar Feb 10 '25 23:02 paulhcsun

update

☑️ Nothing to do

  • [ ] #commits-behind > 0 [📌 update requirement]
  • [X] -closed [📌 update requirement]
  • [X] -conflict [📌 update requirement]
  • [X] queue-position = -1 [📌 update requirement]

mergify[bot] avatar Feb 10 '25 23:02 mergify[bot]

@mergifyio requeue

paulhcsun avatar Feb 10 '25 23:02 paulhcsun

requeue

❌ This pull request head commit has not been previously disembarked from queue.

mergify[bot] avatar Feb 10 '25 23:02 mergify[bot]

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[bot] avatar Feb 10 '25 23:02 mergify[bot]

AWS CodeBuild CI Report

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

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

aws-cdk-automation avatar Feb 11 '25 01:02 aws-cdk-automation

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[bot] avatar Feb 11 '25 01:02 mergify[bot]

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] avatar Feb 11 '25 01:02 github-actions[bot]