docs(s3): bad type definition for objectsKeyPattern parameter #28176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
beginning-contributor
scanlonp
previously approved these changes
Nov 29, 2023
| @@ -786,7 +786,7 @@ export abstract class BucketBase extends Resource implements IBucket { | |||
| * If encryption is used, permission to use the key to encrypt the contents | |||
| * of written files will also be granted to the same principal. | |||
| * @param identity The principal | |||
| * @param objectsKeyPattern Restrict the permission to a certain key pattern (default '*') | |||
| * @param objectsKeyPattern Restrict the permission to a certain key pattern (default '*'). Parameter type is `any` but `string` should be passed in | |||
There was a problem hiding this comment.
Suggested change
| * @param objectsKeyPattern Restrict the permission to a certain key pattern (default '*'). Parameter type is `any` but `string` should be passed in | |
| * @param objectsKeyPattern Restrict the permission to a certain key pattern (default '*'). Parameter type is `any` but `string` should be passed in. |
nit: this one does not have a period.
mergify
bot
dismissed
scanlonp’s stale review
Pull request has been modified.
aws-cdk-automation
added
the
pr/needs-community-review
scanlonp
approved these changes
Nov 29, 2023
|
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
removed
the
pr/needs-community-review
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
chenjane-dev
pushed a commit
to chenjane-dev/aws-cdk
that referenced
this pull request
Dec 5, 2023
) Improve docstrings to explain that parameter objectsKeyPattern of type any should take in string inputs. Unable to directly change the parameter type because of backwards compatibility concerns (mentioned in aws#27486 we are improving documentation as an alternative solution. Closes aws#27481. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve docstrings to explain that parameter objectsKeyPattern of type any should take in string inputs.
Unable to directly change the parameter type because of backwards compatibility concerns (mentioned in #27486 we are improving documentation as an alternative solution.
Closes #27481.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license