Skip to content

CLOUDP-309109: Third rollout for IPA validations #625

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 27, 2025
Merged

CLOUDP-309109: Third rollout for IPA validations #625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00b5939
CLOUDP-309109: Third rollout for IPA validations
yelizhenden-mdb Mar 27, 2025
d54bdcc
ipa spectral overrides
yelizhenden-mdb Mar 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions tools/spectral/ipa/__tests__/IPA102CollectionIdentifierCamelCase.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'Resources' in path '/Resources' is not in camelCase.",
path: ['paths', '/Resources'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -64,7 +64,7 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'resource_groups' in path '/resource_groups' is not in camelCase.",
path: ['paths', '/resource_groups'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -81,7 +81,7 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'resource-groups' in path '/resource-groups' is not in camelCase.",
path: ['paths', '/resource-groups'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -98,7 +98,7 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'Resources' in path '/Resources:createResource' is not in camelCase.",
path: ['paths', '/Resources:createResource'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -115,7 +115,7 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'resourcesAPI' in path '/resourcesAPI' is not in camelCase.",
path: ['paths', '/resourcesAPI'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down Expand Up @@ -147,21 +147,21 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path '/api//users' contains double slashes (//) which is not allowed.",
path: ['paths', '/api//users'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-camelCase',
message:
"Collection identifiers must be in camelCase. Path '/resources///{resourceId}' contains double slashes (//) which is not allowed.",
path: ['paths', '/resources///{resourceId}'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-camelCase',
message:
"Collection identifiers must be in camelCase. Path '//doubleSlashAtStart' contains double slashes (//) which is not allowed.",
path: ['paths', '//doubleSlashAtStart'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -188,21 +188,21 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'API' in path '/API/Resource_groups/{userId}/User-profiles' is not in camelCase.",
path: ['paths', '/API/Resource_groups/{userId}/User-profiles'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-camelCase',
message:
"Collection identifiers must be in camelCase. Path segment 'Resource_groups' in path '/API/Resource_groups/{userId}/User-profiles' is not in camelCase.",
path: ['paths', '/API/Resource_groups/{userId}/User-profiles'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-camelCase',
message:
"Collection identifiers must be in camelCase. Path segment 'User-profiles' in path '/API/Resource_groups/{userId}/User-profiles' is not in camelCase.",
path: ['paths', '/API/Resource_groups/{userId}/User-profiles'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -219,14 +219,14 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path segment 'Valid' in path '/api/Valid/Invalid_resource/{id}:validCustomMethod' is not in camelCase.",
path: ['paths', '/api/Valid/Invalid_resource/{id}:validCustomMethod'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-camelCase',
message:
"Collection identifiers must be in camelCase. Path segment 'Invalid_resource' in path '/api/Valid/Invalid_resource/{id}:validCustomMethod' is not in camelCase.",
path: ['paths', '/api/Valid/Invalid_resource/{id}:validCustomMethod'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -243,14 +243,14 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
message:
"Collection identifiers must be in camelCase. Path '/api//Invalid_segment//resources' contains double slashes (//) which is not allowed.",
path: ['paths', '/api//Invalid_segment//resources'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-camelCase',
message:
"Collection identifiers must be in camelCase. Path segment 'Invalid_segment' in path '/api//Invalid_segment//resources' is not in camelCase.",
path: ['paths', '/api//Invalid_segment//resources'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down
6 changes: 3 additions & 3 deletions tools/spectral/ipa/__tests__/IPA102CollectionIdentifierPattern.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ testRule('xgen-IPA-102-collection-identifier-pattern', [
message:
"Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers (/[a-z][a-zA-Z0-9]*/). Path segment 'Resources' in path '/Resources' doesn't match the required pattern.",
path: ['paths', '/Resources'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand All @@ -65,14 +65,14 @@ testRule('xgen-IPA-102-collection-identifier-pattern', [
message:
"Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers (/[a-z][a-zA-Z0-9]*/). Path segment 'resource-groups' in path '/resource-groups' doesn't match the required pattern.",
path: ['paths', '/resource-groups'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-102-collection-identifier-pattern',
message:
"Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers (/[a-z][a-zA-Z0-9]*/). Path segment 'user_profiles' in path '/user_profiles' doesn't match the required pattern.",
path: ['paths', '/user_profiles'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down
20 changes: 10 additions & 10 deletions tools/spectral/ipa/__tests__/IPA106CreateMethodRequestBodyIsGetResponse.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,50 +394,50 @@ testRule('xgen-IPA-106-create-method-request-body-is-get-method-response', [
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resource', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resource', 'post', 'requestBody', 'content', 'application/vnd.atlas.2024-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resourceTwo', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resourceTwo', 'post', 'requestBody', 'content', 'application/vnd.atlas.2024-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resourceThree', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message:
'Could not validate that the Create request body schema matches the response schema of the Get method. The Get method does not have a schema.',
path: ['paths', '/resourceFour', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resourceCircular', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/resourceCircular', 'post', 'requestBody', 'content', 'application/vnd.atlas.2024-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down Expand Up @@ -486,13 +486,13 @@ testRule('xgen-IPA-106-create-method-request-body-is-get-method-response', [
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/animalResource', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
message: 'The request body schema properties must match the response body schema properties of the Get method.',
path: ['paths', '/animalResource', 'post', 'requestBody', 'content', 'application/vnd.atlas.2024-01-01+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down
6 changes: 3 additions & 3 deletions tools/spectral/ipa/__tests__/IPA106CreateMethodResponseIsGetMethodResponse.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ testRule('xgen-IPA-106-create-method-response-is-get-method-response', [
'content',
'application/vnd.atlas.2024-01-05+json',
],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-106-create-method-response-is-get-method-response',
Expand All @@ -256,7 +256,7 @@ testRule('xgen-IPA-106-create-method-response-is-get-method-response', [
'content',
'application/vnd.atlas.2024-01-05+json',
],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down Expand Up @@ -302,7 +302,7 @@ testRule('xgen-IPA-106-create-method-response-is-get-method-response', [
code: 'xgen-IPA-106-create-method-response-is-get-method-response',
message: 'The schema in the Create method response must be the same schema as the response of the Get method.',
path: ['paths', '/resources', 'post', 'responses', '201', 'content', 'application/vnd.atlas.2024-08-05+json'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down
12 changes: 6 additions & 6 deletions tools/spectral/ipa/__tests__/IPA107UpdateMethodMustNotHaveQueryParams.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,19 +123,19 @@ testRule('xgen-IPA-107-update-must-not-have-query-params', [
code: 'xgen-IPA-107-update-must-not-have-query-params',
message: 'Update operations must not have query parameters. Found [filter].',
path: ['paths', '/resource/{id}', 'put'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-107-update-must-not-have-query-params',
message: 'Update operations must not have query parameters. Found [query-param].',
path: ['paths', '/resource/{id}/singleton', 'put'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-107-update-must-not-have-query-params',
message: 'Update operations must not have query parameters. Found [query-param-2].',
path: ['paths', '/resource/{id}/singleton', 'put'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down Expand Up @@ -259,19 +259,19 @@ testRule('xgen-IPA-107-update-must-not-have-query-params', [
code: 'xgen-IPA-107-update-must-not-have-query-params',
message: 'Update operations must not have query parameters. Found [filter].',
path: ['paths', '/resource/{id}', 'patch'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-107-update-must-not-have-query-params',
message: 'Update operations must not have query parameters. Found [query-param].',
path: ['paths', '/resource/{id}/singleton', 'patch'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
{
code: 'xgen-IPA-107-update-must-not-have-query-params',
message: 'Update operations must not have query parameters. Found [query-param-2].',
path: ['paths', '/resource/{id}/singleton', 'patch'],
severity: DiagnosticSeverity.Warning,
severity: DiagnosticSeverity.Error,
},
],
},
Expand Down
Loading
Loading