fixes

Author: yelizhenden-mdb

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

@@ -134,36 +134,6 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
     },
     errors: []
   },
-  {
-    name: 'paths with project field name',
-    document: {
-      paths: {
-        '/api/resource': {
-          post: {
-            requestBody: {
-              content: {
-                'application/json': {
-                  schema: {
-                    properties: {
-                      project: { type: 'string' }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    errors: [
-      {
-        code: 'xgen-IPA-112-avoid-project-field-names',
-        message: 'Field name "project" should be avoided. Consider using "group", "groups", or "groupId" instead.',
-        path: ['paths', '/api/resource', 'post', 'requestBody', 'content', 'application/json', 'schema', 'properties', 'project'],
-        severity: DiagnosticSeverity.Warning
-      }
-    ]
-  },
   {
     name: 'field name containing project substring',
     document: {
@@ -232,54 +202,6 @@ testRule('xgen-IPA-112-avoid-project-field-names', [
     },
     errors: []
   },
-  {
-    name: 'exception - schema level exception for all properties',
-    document: {
-      components: {
-        schemas: {
-          SchemaName: {
-            'x-xgen-IPA-exception': {
-              'xgen-IPA-112-avoid-project-field-names': 'Legacy schema that cannot be changed'
-            },
-            properties: {
-              projectId: { type: 'string' },
-              projects: { type: 'array' },
-              myProjectDetails: { type: 'object' }
-            }
-          }
-        }
-      }
-    },
-    errors: []
-  },
-  {
-    name: 'exception - in paths',
-    document: {
-      paths: {
-        '/api/resource': {
-          post: {
-            requestBody: {
-              content: {
-                'application/json': {
-                  schema: {
-                    properties: {
-                      project: {
-                        type: 'string',
-                        'x-xgen-IPA-exception': {
-                          'xgen-IPA-112-avoid-project-field-names': 'Third-party integration requirement'
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    errors: []
-  },
   {
     name: 'mixed valid, invalid, and exception fields',
     document: {

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

@@ -12,12 +12,13 @@ rules:
       ##### Implementation details
       Rule checks for the following conditions:
         - Searches through all schemas in the API definition
-        - Identifies property names that match "group", "groups", or "groupId" (case-insensitive)
+        - Identifies property names that match "project" (case-insensitive)
         - Reports any instances where these field names are used
         - Suggests using "group", "groups", or "groupId" as alternatives
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-112-avoid-project-field-names'
     severity: warn
-    given: '$..[?(@.properties)]'
+    given: "$.components.schemas..properties[*]~"
     then:
-      field: @key
-      function: 'IPA112AvoidProjectFieldNames'
+      function: 'IPA112AvoidProjectFieldNames'
+      functionOptions:
+        prohibitedFieldName: "project"

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

@@ -9,7 +9,8 @@ import { resolveObject } from './utils/componentUtils.js';
 
 const RULE_NAME = 'xgen-IPA-112-avoid-project-field-names';
 
-export default (input, _, { path, documentInventory }) => {
+export default (input, options, { path, documentInventory }) => {
+
   const oas = documentInventory.resolved;
   const property = resolveObject(oas, path);
 
@@ -18,28 +19,26 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  const errors = checkViolationsAndReturnErrors(input, path);
+  const errors = checkViolationsAndReturnErrors(input, options, path);
   if (errors.length !== 0) {
     return collectAndReturnViolation(path, RULE_NAME, errors);
   }
-  collectAdoption(input, RULE_NAME);
+  collectAdoption(path, RULE_NAME);
+
 };
 
-function checkViolationsAndReturnErrors(input, path) {
-  const errors = [];
+function checkViolationsAndReturnErrors(input, options, path) {
   try {
-    const prohibitedName = "project";
-
+    const prohibitedFieldName = options?.prohibitedFieldName || "";
     const lowerPropertyName = input.toLowerCase();
-
-    if (lowerPropertyName.includes(prohibitedName)) {
-      errors.push({
+    if (lowerPropertyName.includes(prohibitedFieldName)) {
+      return [{
         path,
         message: `Field name "${input}" should be avoided. Consider using "group", "groups", or "groupId" instead.`
-      });
+      }];
     }
 
-    return errors;
+    return [];
   } catch (e) {
     handleInternalError(RULE_NAME, path, e);
   }