Skip to content

Commit 5fcbc74

Browse files
docs fix
1 parent 540de25 commit 5fcbc74

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

tools/spectral/ipa/__tests__/IPA124ArrayMaxItems.test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ testRule('xgen-IPA-124-array-max-items', [
4646
errors: [
4747
{
4848
code: 'xgen-IPA-124-array-max-items',
49-
message: 'Array must have maxItems property defined.',
49+
message: 'Array must have maxItems property defined to enforce an upper bound on the number of items.',
5050
path: ['components', 'schemas', 'InvalidSchema', 'properties', 'items'],
5151
severity: DiagnosticSeverity.Warning,
5252
},
@@ -168,7 +168,7 @@ testRule('xgen-IPA-124-array-max-items', [
168168
errors: [
169169
{
170170
code: 'xgen-IPA-124-array-max-items',
171-
message: 'Array must have maxItems property defined.',
171+
message: 'Array must have maxItems property defined to enforce an upper bound on the number of items.',
172172
path: [
173173
'paths',
174174
'/api/resources',

tools/spectral/ipa/rulesets/IPA-124.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ functions:
77
rules:
88
xgen-IPA-124-array-max-items:
99
description: |
10-
Array fields must have a maxItems property defined with a value of 100.
10+
Array fields must have a maxItems property defined to enforce an upper bound on the number of items (default: 100).
1111
1212
##### Implementation details
1313
Rule checks for the following conditions:

tools/spectral/ipa/rulesets/functions/IPA124ArrayMaxItems.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ function checkViolationsAndReturnErrors(input, path, maxItems) {
3636
if (input.maxItems === undefined) {
3737
return [
3838
{
39-
message: `Array must have maxItems property defined.`,
39+
message: `Array must have maxItems property defined to enforce an upper bound on the number of items.`,
4040
path,
4141
},
4242
];

0 commit comments

Comments
 (0)