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

fix(apigateway): validation for path parts does not allow creation of resources beginning with dollar sign #27619

Merged

Conversation

lawofcycles
Copy link
Contributor

@lawofcycles lawofcycles commented Oct 20, 2023

This PR adjusts the validation rules for path parts in resources created using the APIGateway library to allow the use of dollar mark in pathParts, as requested in #27083. This enables the creation of resources with paths such as $test(from the reproduction steps in the related issue).

An existing resource unit test ('url for a resource') has been updated to ensure that a dollar mark in a pathPart does not throw an error and properly reflects in the output of RestApi.urlForPath. The integration test integ.restapi has also been updated, wherein the appliances resource now has a path of $appliances:all instead of appliances:all.

Closes #27083.

All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Oct 20, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team October 20, 2023 00:42
@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p2 labels Oct 20, 2023
@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 Oct 20, 2023
Copy link
Contributor

@lpizzinidev lpizzinidev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍
Can you please update the title to describe the bug as per guidelines?
Suggestion: fix(apigateway): validation for path parts does not allow creation of resources with dollar sign.

@aws-cdk-automation aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Oct 20, 2023
@lawofcycles lawofcycles changed the title fix(api-gateway): Error: Resource's path part only allow [a-zA-Z0-9:._-], an optional trailing '+'(module name) fix(apigateway): validation for path parts does not allow creation of resources with dollar sign Oct 20, 2023
@lawofcycles
Copy link
Contributor Author

lawofcycles commented Oct 20, 2023

I misunderstood guideline that name of PR should be same to name of related issue.
I changed the title.

scanlonp
scanlonp previously approved these changes Oct 20, 2023
Copy link
Contributor

@scanlonp scanlonp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@scanlonp scanlonp changed the title fix(apigateway): validation for path parts does not allow creation of resources with dollar sign fix(apigateway): validation for path parts does not allow creation of resources beginning with dollar sign Oct 20, 2023
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 20, 2023
@mergify
Copy link
Contributor

mergify bot commented Oct 20, 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).

@lawofcycles
Copy link
Contributor Author

lawofcycles commented Oct 21, 2023

@scanlonp
According to workflow, it seems some checks were not successful

Queue: Embarked in merge queue — This pull request cannot be embarked for merge

I would appreciate it if you could let me know if further action is needed to resolve this issue.

@mergify mergify bot dismissed scanlonp’s stale review October 26, 2023 14:03

Pull request has been modified.

@scanlonp
Copy link
Contributor

@Mergifyio update

@mergify
Copy link
Contributor

mergify bot commented Oct 26, 2023

update

✅ Branch has been successfully updated

@mergify
Copy link
Contributor

mergify bot commented Oct 26, 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
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 12d4ff3
  • 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 a8f5326 into aws:main Oct 26, 2023
10 checks passed
@mergify
Copy link
Contributor

mergify bot commented Oct 26, 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).

mrgrain pushed a commit that referenced this pull request Nov 1, 2023
… resources beginning with dollar sign (#27619)

This PR adjusts the validation rules for path parts in resources created using the APIGateway library to allow the use of dollar mark in pathParts, as requested in #27083. This enables the creation of resources with paths such as $test(from the reproduction steps in the related issue).

An existing resource unit test ('url for a resource') has been updated to ensure that a dollar mark in a pathPart does not throw an error and properly reflects in the output of RestApi.urlForPath. The integration test integ.restapi has also been updated, wherein the appliances resource now has a path of $appliances:all instead of appliances:all.

Closes #27083.

#### All Submissions:
- [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)
#### Adding new Unconventional Dependencies:
- [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)
#### New Features
- [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
  - [x] Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error: Resource's path part only allow [a-zA-Z0-9:._-], an optional trailing '+'(module name)
4 participants