Skip to content

Commit 0d8509e

Browse files
yelizhenden-mdbyelizhenden-mdb
committed
CLOUDP-310612: Fourth Rollout of IPA validations
1 parent c4bec38 commit 0d8509e

22 files changed

+125
-125
lines changed

‎tools/spectral/ipa/__tests__/IPA110CollectionsRequestHasItemsPerPageQueryParam.test.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ testRule('xgen-IPA-110-collections-request-has-itemsPerPage-query-param', [
7575
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
7676
message: 'List method is missing query parameters.',
7777
path: ['paths', '/resources', 'get'],
78-
severity: DiagnosticSeverity.Warning,
78+
severity: DiagnosticSeverity.Error,
7979
},
8080
],
8181
},
@@ -120,13 +120,13 @@ testRule('xgen-IPA-110-collections-request-has-itemsPerPage-query-param', [
120120
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
121121
message: 'List method is missing a itemsPerPage query parameter.',
122122
path: ['paths', '/resources', 'get'],
123-
severity: DiagnosticSeverity.Warning,
123+
severity: DiagnosticSeverity.Error,
124124
},
125125
{
126126
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
127127
message: 'List method is missing a itemsPerPage query parameter.',
128128
path: ['paths', '/resourcesTwo', 'get'],
129-
severity: DiagnosticSeverity.Warning,
129+
severity: DiagnosticSeverity.Error,
130130
},
131131
],
132132
},
@@ -159,7 +159,7 @@ testRule('xgen-IPA-110-collections-request-has-itemsPerPage-query-param', [
159159
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
160160
message: 'itemsPerPage query parameter of List method must not be required.',
161161
path: ['paths', '/resources', 'get'],
162-
severity: DiagnosticSeverity.Warning,
162+
severity: DiagnosticSeverity.Error,
163163
},
164164
],
165165
},
@@ -190,7 +190,7 @@ testRule('xgen-IPA-110-collections-request-has-itemsPerPage-query-param', [
190190
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
191191
message: 'itemsPerPage query parameter of List method must have a default value defined.',
192192
path: ['paths', '/resources', 'get'],
193-
severity: DiagnosticSeverity.Warning,
193+
severity: DiagnosticSeverity.Error,
194194
},
195195
],
196196
},
@@ -222,7 +222,7 @@ testRule('xgen-IPA-110-collections-request-has-itemsPerPage-query-param', [
222222
code: 'xgen-IPA-110-collections-request-has-itemsPerPage-query-param',
223223
message: 'itemsPerPage query parameter of List method must have a default value of 100.',
224224
path: ['paths', '/resources', 'get'],
225-
severity: DiagnosticSeverity.Warning,
225+
severity: DiagnosticSeverity.Error,
226226
},
227227
],
228228
},

‎tools/spectral/ipa/__tests__/IPA110CollectionsRequestHasPageNumQueryParam.test.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ testRule('xgen-IPA-110-collections-request-has-pageNum-query-param', [
7575
code: 'xgen-IPA-110-collections-request-has-pageNum-query-param',
7676
message: 'List method is missing query parameters.',
7777
path: ['paths', '/resources', 'get'],
78-
severity: DiagnosticSeverity.Warning,
78+
severity: DiagnosticSeverity.Error,
7979
},
8080
],
8181
},
@@ -120,13 +120,13 @@ testRule('xgen-IPA-110-collections-request-has-pageNum-query-param', [
120120
code: 'xgen-IPA-110-collections-request-has-pageNum-query-param',
121121
message: 'List method is missing a pageNum query parameter.',
122122
path: ['paths', '/resources', 'get'],
123-
severity: DiagnosticSeverity.Warning,
123+
severity: DiagnosticSeverity.Error,
124124
},
125125
{
126126
code: 'xgen-IPA-110-collections-request-has-pageNum-query-param',
127127
message: 'List method is missing a pageNum query parameter.',
128128
path: ['paths', '/resourcesTwo', 'get'],
129-
severity: DiagnosticSeverity.Warning,
129+
severity: DiagnosticSeverity.Error,
130130
},
131131
],
132132
},
@@ -159,7 +159,7 @@ testRule('xgen-IPA-110-collections-request-has-pageNum-query-param', [
159159
code: 'xgen-IPA-110-collections-request-has-pageNum-query-param',
160160
message: 'pageNum query parameter of List method must not be required.',
161161
path: ['paths', '/resources', 'get'],
162-
severity: DiagnosticSeverity.Warning,
162+
severity: DiagnosticSeverity.Error,
163163
},
164164
],
165165
},
@@ -190,7 +190,7 @@ testRule('xgen-IPA-110-collections-request-has-pageNum-query-param', [
190190
code: 'xgen-IPA-110-collections-request-has-pageNum-query-param',
191191
message: 'pageNum query parameter of List method must have a default value defined.',
192192
path: ['paths', '/resources', 'get'],
193-
severity: DiagnosticSeverity.Warning,
193+
severity: DiagnosticSeverity.Error,
194194
},
195195
],
196196
},
@@ -222,7 +222,7 @@ testRule('xgen-IPA-110-collections-request-has-pageNum-query-param', [
222222
code: 'xgen-IPA-110-collections-request-has-pageNum-query-param',
223223
message: 'pageNum query parameter of List method must have a default value of 1.',
224224
path: ['paths', '/resources', 'get'],
225-
severity: DiagnosticSeverity.Warning,
225+
severity: DiagnosticSeverity.Error,
226226
},
227227
],
228228
},

‎tools/spectral/ipa/__tests__/IPA110CollectionsRequestIncludeCountNotRequired.test.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ testRule('xgen-IPA-110-collections-request-includeCount-not-required', [
120120
code: 'xgen-IPA-110-collections-request-includeCount-not-required',
121121
message: 'includeCount query parameter of List method must not be required.',
122122
path: ['paths', '/resources', 'get'],
123-
severity: DiagnosticSeverity.Warning,
123+
severity: DiagnosticSeverity.Error,
124124
},
125125
],
126126
},
@@ -156,7 +156,7 @@ testRule('xgen-IPA-110-collections-request-includeCount-not-required', [
156156
code: 'xgen-IPA-110-collections-request-includeCount-not-required',
157157
message: 'includeCount query parameter of List method must not be required.',
158158
path: ['paths', '/resources', 'get'],
159-
severity: DiagnosticSeverity.Warning,
159+
severity: DiagnosticSeverity.Error,
160160
},
161161
],
162162
},

‎tools/spectral/ipa/__tests__/IPA110CollectionsResponseDefineLinksArray.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ testRule('xgen-IPA-110-collections-response-define-links-array', [
108108
message:
109109
'The response for collections should define a links array field, providing links to next and previous pages.',
110110
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/json'],
111-
severity: DiagnosticSeverity.Warning,
111+
severity: DiagnosticSeverity.Error,
112112
},
113113
],
114114
},

‎tools/spectral/ipa/__tests__/IPA110CollectionsResponseDefineResultsArray.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ testRule('xgen-IPA-110-collections-response-define-results-array', [
147147
code: 'xgen-IPA-110-collections-response-define-results-array',
148148
message: 'The response for collections must define an array of results containing the paginated resource.',
149149
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/json'],
150-
severity: DiagnosticSeverity.Warning,
150+
severity: DiagnosticSeverity.Error,
151151
},
152152
],
153153
},

‎tools/spectral/ipa/__tests__/IPA110CollectionsUsePaginatedPrefix.test.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ testRule('xgen-IPA-110-collections-use-paginated-prefix', [
110110
message:
111111
'List methods response must reference a paginated response schema. The response should reference a schema with "Paginated" prefix.',
112112
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/json'],
113-
severity: DiagnosticSeverity.Warning,
113+
severity: DiagnosticSeverity.Error,
114114
},
115115
],
116116
},
@@ -151,21 +151,21 @@ testRule('xgen-IPA-110-collections-use-paginated-prefix', [
151151
message:
152152
'List methods response must reference a paginated response schema. The response should reference a schema with "Paginated" prefix.',
153153
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2024-08-05+json'],
154-
severity: DiagnosticSeverity.Warning,
154+
severity: DiagnosticSeverity.Error,
155155
},
156156
{
157157
code: 'xgen-IPA-110-collections-use-paginated-prefix',
158158
message:
159159
'List methods response must reference a paginated response schema. The schema is defined inline and must reference a predefined paginated schema.',
160160
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2024-01-01+json'],
161-
severity: DiagnosticSeverity.Warning,
161+
severity: DiagnosticSeverity.Error,
162162
},
163163
{
164164
code: 'xgen-IPA-110-collections-use-paginated-prefix',
165165
message:
166166
'List methods response must reference a paginated response schema. The List method response does not have a schema defined.',
167167
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2024-03-03+json'],
168-
severity: DiagnosticSeverity.Warning,
168+
severity: DiagnosticSeverity.Error,
169169
},
170170
],
171171
},
@@ -212,7 +212,7 @@ testRule('xgen-IPA-110-collections-use-paginated-prefix', [
212212
code: 'xgen-IPA-110-collections-use-paginated-prefix',
213213
message: 'The schema is defined inline and must reference a predefined paginated schema.',
214214
path: ['paths', '/resources', 'get', 'responses', '200', 'content', 'application/json'],
215-
severity: DiagnosticSeverity.Warning,
215+
severity: DiagnosticSeverity.Error,
216216
},
217217
],
218218
},

‎tools/spectral/ipa/__tests__/IPA112AvoidProjectFieldNames.test.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,25 +109,25 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
109109
code: 'xgen-IPA-112-avoid-project-field-names',
110110
message: 'Field name "project" should be avoided. Consider using "group" instead.',
111111
path: ['components', 'schemas', 'SchemaName', 'properties', 'project'],
112-
severity: DiagnosticSeverity.Warning,
112+
severity: DiagnosticSeverity.Error,
113113
},
114114
{
115115
code: 'xgen-IPA-112-avoid-project-field-names',
116116
message: 'Field name "projects" should be avoided. Consider using "groups" instead.',
117117
path: ['components', 'schemas', 'SchemaName', 'properties', 'projects'],
118-
severity: DiagnosticSeverity.Warning,
118+
severity: DiagnosticSeverity.Error,
119119
},
120120
{
121121
code: 'xgen-IPA-112-avoid-project-field-names',
122122
message: 'Field name "projectId" should be avoided. Consider using "group" instead.',
123123
path: ['components', 'schemas', 'SchemaName', 'properties', 'projectId'],
124-
severity: DiagnosticSeverity.Warning,
124+
severity: DiagnosticSeverity.Error,
125125
},
126126
{
127127
code: 'xgen-IPA-112-avoid-project-field-names',
128128
message: 'Field name "myProjectDetails" should be avoided. Consider using "group" instead.',
129129
path: ['components', 'schemas', 'SchemaName', 'properties', 'myProjectDetails'],
130-
severity: DiagnosticSeverity.Warning,
130+
severity: DiagnosticSeverity.Error,
131131
},
132132
{
133133
code: 'xgen-IPA-112-avoid-project-field-names',
@@ -143,7 +143,7 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
143143
'properties',
144144
'projectId',
145145
],
146-
severity: DiagnosticSeverity.Warning,
146+
severity: DiagnosticSeverity.Error,
147147
},
148148
{
149149
code: 'xgen-IPA-112-avoid-project-field-names',
@@ -160,7 +160,7 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
160160
'properties',
161161
'projectId',
162162
],
163-
severity: DiagnosticSeverity.Warning,
163+
severity: DiagnosticSeverity.Error,
164164
},
165165
],
166166
},

‎tools/spectral/ipa/__tests__/IPA112BooleanFieldNamesAvoidIsPrefix.test.js‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -108,19 +108,19 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
108108
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
109109
message: 'Boolean field "isEnabled" should not use the "is" prefix. Use "enabled" instead.',
110110
path: ['components', 'schemas', 'SchemaName', 'properties', 'isEnabled'],
111-
severity: DiagnosticSeverity.Warning,
111+
severity: DiagnosticSeverity.Error,
112112
},
113113
{
114114
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
115115
message: 'Boolean field "isActive" should not use the "is" prefix. Use "active" instead.',
116116
path: ['components', 'schemas', 'SchemaName', 'properties', 'isActive'],
117-
severity: DiagnosticSeverity.Warning,
117+
severity: DiagnosticSeverity.Error,
118118
},
119119
{
120120
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
121121
message: 'Boolean field "isError" should not use the "is" prefix. Use "error" instead.',
122122
path: ['components', 'schemas', 'SchemaName', 'properties', 'isError'],
123-
severity: DiagnosticSeverity.Warning,
123+
severity: DiagnosticSeverity.Error,
124124
},
125125
{
126126
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
@@ -136,7 +136,7 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
136136
'properties',
137137
'isAvailable',
138138
],
139-
severity: DiagnosticSeverity.Warning,
139+
severity: DiagnosticSeverity.Error,
140140
},
141141
{
142142
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
@@ -153,7 +153,7 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
153153
'properties',
154154
'isValid',
155155
],
156-
severity: DiagnosticSeverity.Warning,
156+
severity: DiagnosticSeverity.Error,
157157
},
158158
],
159159
},
@@ -235,13 +235,13 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
235235
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
236236
message: 'Boolean field "isEnabled" should not use the "is" prefix. Use "enabled" instead.',
237237
path: ['components', 'schemas', 'BooleanProperties', 'properties', 'isEnabled'],
238-
severity: DiagnosticSeverity.Warning,
238+
severity: DiagnosticSeverity.Error,
239239
},
240240
{
241241
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
242242
message: 'Boolean field "isAdmin" should not use the "is" prefix. Use "admin" instead.',
243243
path: ['components', 'schemas', 'User', 'properties', 'isAdmin'],
244-
severity: DiagnosticSeverity.Warning,
244+
severity: DiagnosticSeverity.Error,
245245
},
246246
{
247247
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
@@ -256,7 +256,7 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
256256
'properties',
257257
'isEmailNotificationsEnabled',
258258
],
259-
severity: DiagnosticSeverity.Warning,
259+
severity: DiagnosticSeverity.Error,
260260
},
261261
{
262262
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
@@ -273,7 +273,7 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
273273
'properties',
274274
'isCached',
275275
],
276-
severity: DiagnosticSeverity.Warning,
276+
severity: DiagnosticSeverity.Error,
277277
},
278278
],
279279
},
@@ -316,7 +316,7 @@ testRule('xgen-IPA-112-boolean-field-names-avoid-is-prefix', [
316316
code: 'xgen-IPA-112-boolean-field-names-avoid-is-prefix',
317317
message: 'Boolean field "isMfaEnabled" should not use the "is" prefix. Use "mfaEnabled" instead.',
318318
path: ['components', 'schemas', 'UserSettings', 'properties', 'isMfaEnabled'],
319-
severity: DiagnosticSeverity.Warning,
319+
severity: DiagnosticSeverity.Error,
320320
},
321321
],
322322
},

0 commit comments

Comments
 (0)