CLOUDP-306579: Repeated Fields #653
Merged
+529
−0
Conversation
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
yelizhenden-mdb
commented
Apr 3, 2025
| - Validates that each enum array has 20 or fewer values | ||
| - Reusable enum schemas will be ignored | ||
| - Skips validation if the schema has an exception defined for this rule | ||
| - This validation threshold can be adjusted by changing the functionOptions.maxEnumValues parameter |
There was a problem hiding this comment.
FYI: drive-by fix
| rules: | ||
| xgen-IPA-124-array-max-items: | ||
| description: | | ||
| Array fields must have a maxItems property defined to enforce an upper bound on the number of items (default: 100). |
There was a problem hiding this comment.
Suggested change
| Array fields must have a maxItems property defined to enforce an upper bound on the number of items (default: 100). | |
| Array fields must have a maxItems property defined to enforce an upper bound on the number of items (recommended max: 100). If repeated data has the chance of being too large, the API should use a sub-resource instead. |
[Nit] Include guidance on option instead of very large array
There was a problem hiding this comment.
I changed repeated data with array field to be consistent, and kept the rest. Let me know how it looks 👍
|
|
||
| testRule('xgen-IPA-124-array-max-items', [ | ||
| { | ||
| name: 'valid array with maxItems set to 100', |
There was a problem hiding this comment.
Can you also add a case with valid maxItems: <value lower than 100>?
There was a problem hiding this comment.
Addressed, let me know how it looks 👍
Comment on lines
121
to
131
| properties: { | ||
| outerArray: { | ||
| type: 'array', | ||
| maxItems: 100, | ||
| arrayProperty: { | ||
| type: 'array', | ||
| maxItems: 101, | ||
| items: { | ||
| type: 'string', | ||
| }, | ||
| }, |
There was a problem hiding this comment.
Can you add a case where both the outer and nested array has a too large value?
There was a problem hiding this comment.
Addressed, let me know how it looks 👍
lovisaberggren
approved these changes
Apr 3, 2025
| rules: | ||
| xgen-IPA-124-array-max-items: | ||
| description: | | ||
| Array fields must have a maxItems property defined to enforce an upper bound on the number of items (recommended max: 100). If the array field has the chance of being too large, the API should use a sub-resource instead.. |
There was a problem hiding this comment.
Suggested change
| Array fields must have a maxItems property defined to enforce an upper bound on the number of items (recommended max: 100). If the array field has the chance of being too large, the API should use a sub-resource instead.. | |
| Array fields must have a maxItems property defined to enforce an upper bound on the number of items (recommended max: 100). If the array field has the chance of being too large, the API should use a sub-resource instead. |
lovisaberggren
approved these changes
Apr 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Proposed changes
Jira ticket: CLOUDP-306579
Found 426 violations to fix.
Planned fix: No exceptions, but adding maxItems for the violating array fields
Checklist
Changes to Spectral
Further comments