Skip to content

Conversation

@matoom-nomu
Copy link
Contributor

@matoom-nomu matoom-nomu commented Sep 16, 2025

Issue #35498

Reason for this change

The SpecRestApi construct was missing the binaryMediaTypes property that is available in the regular RestApi construct.

Description of changes

  • Added binaryMediaTypes property to SpecRestApiProps interface**: This property accepts an array of strings representing binary media types (e.g., ['image/png', 'application/pdf'])
  • Updated SpecRestApi constructor**: Modified to pass the binaryMediaTypes property to the underlying CfnRestApi resource
  • Updated README documentation: Added usage example showing how to use binaryMediaTypes with SpecRestApi

Describe any new or updated permissions being added

N/A

Description of how you validated changes

  • Added unit tests: Created tests to verify that the binaryMediaTypes property is correctly passed to CloudFormation
  • Added integration tests: Updated existing integration test to include binaryMediaTypes configuration

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 September 16, 2025 05:06
@github-actions github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Sep 16, 2025
@matoom-nomu matoom-nomu force-pushed the feature/add-binaryMediaTypes-property-to-SpecRestApi branch from 1754d12 to f37a525 Compare September 16, 2025 05:09
@matoom-nomu matoom-nomu force-pushed the feature/add-binaryMediaTypes-property-to-SpecRestApi branch from 2c0ed78 to 18974e5 Compare September 16, 2025 05:16
@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. labels Sep 23, 2025
@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 Sep 23, 2025
@kumsmrit kumsmrit self-assigned this Oct 8, 2025
Copy link
Contributor

@kumsmrit kumsmrit left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution. I have added a minor review comment.

* The list of binary media mime-types that are supported by the RestApi
* resource, such as "image/png" or "application/octet-stream"
*
* @default - RestApi supports only UTF-8-encoded text payloads.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: RestApi -> SpecRestApi

Copy link
Contributor Author

@matoom-nomu matoom-nomu Oct 30, 2025

Choose a reason for hiding this comment

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

i fixed comment, thanks for review.

kumsmrit
kumsmrit previously approved these changes Oct 30, 2025
@mergify
Copy link
Contributor

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

@mergify
Copy link
Contributor

mergify bot commented Oct 30, 2025

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

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/codebuild-pr-build.yml without workflows permission.

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Oct 30, 2025
@mergify mergify bot dismissed kumsmrit’s stale review October 30, 2025 15:36

Pull request has been modified.

@mergify
Copy link
Contributor

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

@mergify mergify bot merged commit bf10d94 into aws:main Oct 30, 2025
22 of 23 checks passed
@github-actions
Copy link
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 Oct 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants