fix(cloud-assembly-schema): add a valid example for CcApiContextQuery#538
Merged
fix(cloud-assembly-schema): add a valid example for CcApiContextQuery#538
Conversation
This type is being exposed as-is in the CDK library, by copying it into
the public API surface. It therefore gets processed by jsii, and
examples get generated for it.
Because we don't have an example for this type and jsii cannot express
string literal types, the automatically generated example is based
off the type `string` and looks like this:
```ts
{
expectedMatchCount: 'expectedMatchCount',
}
```
This example does not compile because the generated value does not
conform to the actual declared type.
To solve this, we add a valid example here into the base code.
mrgrain
approved these changes
May 27, 2025
Signed-off-by: github-actions <github-actions@github.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #538 +/- ##
==========================================
- Coverage 79.01% 78.88% -0.13%
==========================================
Files 47 47
Lines 7032 7032
Branches 786 780 -6
==========================================
- Hits 5556 5547 -9
- Misses 1458 1467 +9
Partials 18 18
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 task
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This type is being exposed as-is in the CDK library, by copying it into the public API surface. It therefore gets processed by jsii, and examples get generated for it.
Because we don't have an example for this type and jsii cannot express string literal types, the automatically generated example is based off the type
stringand looks like this:This example does not compile because the generated value does not conform to the actual declared type.
To solve this, we add a valid example here into the base code.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license