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: api-gateway JsonSchema additionalItems interface #33879

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jusdino
Copy link
Contributor

@jusdino jusdino commented Mar 23, 2025

Issue #33878

Closes #33878.

Reason for this change

Fix a bug in the JsonSchema interface.

🚨 This is a breaking change, but should be acceptable, since the bug prevented use of the changed interface portion 🚨

Description of changes

Changing the JsonSchema.additionalItems type from JsonSchema[] to JsonSchema | boolean to match Json Schema Draft-04. This enables deployment of API Gateway models that include the additionalItems property.

Describe any new or updated permissions being added

None

Description of how you validated changes

Added an integration test to validate that it fixes the deployment issue.

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 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. p2 labels Mar 23, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team March 23, 2025 02:22
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

(This review is outdated)

@jusdino jusdino changed the title aws-apigateway: Fix JsonSchema additionalItems interface fix: api-gateway JsonSchema additionalItems interface Mar 23, 2025
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 23, 2025 02:25

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Copy link

codecov bot commented Mar 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.38%. Comparing base (2dc5d70) to head (a11b526).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33879   +/-   ##
=======================================
  Coverage   82.38%   82.38%           
=======================================
  Files         120      120           
  Lines        6938     6938           
  Branches     1170     1170           
=======================================
  Hits         5716     5716           
  Misses       1119     1119           
  Partials      103      103           
Flag Coverage Δ
suite.unit 82.38% <ø> (ø)

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.38% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jusdino
Copy link
Contributor Author

jusdino commented Mar 23, 2025

I think that the CodeBuild check is failing because this is a breaking API change. I'm not sure how to use allowed-breaking-changes.txt to indicate to the check that the break is intentional and should be OK. If I understand the breaking change policy for this project right, this break should be acceptable, since the bug that this PR fixes prevents use of the part of the interface that is changing.

@jusdino jusdino force-pushed the aws-apigateway/fix-json-schema-interface branch from 2e19b50 to a11b526 Compare March 23, 2025 04:05
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

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. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-apigateway: JsonSchema additionalItems is undeployable
2 participants