CLOUDP 328959: OperationID Validation functions for Create, Delete, and Update methods

package.json

@@ -14,9 +14,6 @@
         "precommit": "husky install"
     },
     "jest": {
-        "transformIgnorePatterns": [
-            "/node_modules/(?!ember-inflector/)"
-        ],
         "transform": {
             "^.+\\.[t|j]sx?$": "babel-jest"
         },
@@ -36,6 +33,7 @@
         "dotenv": "^17.0.1",
         "ember-inflector": "^6.0.0",
         "eslint-plugin-jest": "^29.0.1",
+        "inflection": "^3.0.2",
         "markdown-table": "^3.0.4",
         "openapi-to-postmanv2": "5.0.0",
         "parquet-wasm": "^0.6.1"
@@ -49,14 +47,14 @@
         "aws-sdk-client-mock": "^4.1.0",
         "babel-jest": "^30.0.2",
         "babel-plugin-transform-import-meta": "^2.3.3",
+        "brace-expansion": "4.0.1",
         "eslint": "^9.30.1",
         "eslint-plugin-require-extensions": "^0.1.3",
         "globals": "^16.3.0",
         "husky": "^9.1.7",
         "jest": "^30.0.3",
         "lint-staged": "^16.1.2",
-        "prettier": "3.6.2",
-        "brace-expansion": "4.0.1"
+        "prettier": "3.6.2"
     },
     "engineStrict": false,
     "engines": {

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

@@ -8,6 +8,7 @@ functions:
   - IPA106CreateMethodRequestHasNoReadonlyFields
   - IPA106CreateMethodResponseCodeIs201Created
   - IPA106CreateMethodResponseIsGetMethodResponse
+  - IPA106ValidOperationID
 
 aliases:
   CreateOperationObject:
@@ -112,3 +113,17 @@ rules:
     then:
       field: '@key'
       function: 'IPA106CreateMethodResponseIsGetMethodResponse'
+  xgen-IPA-106-valid-operation-id:
+    description: |
+      OperationID should be compliant with IPA-106 Naming guidelines.
+
+      ##### Implementation details
+      Rule checks for the following conditions:
+        - Applies only to POST methods on resource collection paths
+        - Generates the expected OperationId given the resource identifier
+        - Compares the generated IPA Compliant OperationId with the existing OperationId
+    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-106-valid-operation-id'
+    severity: off
+    given: '#CreateOperationObject'
+    then:
+      function: 'IPA106ValidOperationID'

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

@@ -8,6 +8,7 @@ functions:
   - IPA107UpdateMethodRequestHasNoReadonlyFields
   - IPA107UpdateMethodRequestBodyIsGetResponse
   - IPA107UpdateMethodRequestBodyIsUpdateRequestSuffixedObject
+  - IPA107ValidOperationID
 
 aliases:
   UpdateOperationObject:
@@ -112,3 +113,17 @@ rules:
     then:
       field: '@key'
       function: 'IPA107UpdateMethodRequestBodyIsUpdateRequestSuffixedObject'
+  xgen-IPA-107-valid-operation-id:
+    description: |
+      OperationID should be compliant with IPA-107 Naming guidelines.
+
+      ##### Implementation details
+      Rule checks for the following conditions:
+        - Validation checks the PATCH/PUT methods for single resource paths and [singleton resources](https://go/ipa/113).
+        - Generates the expected OperationId given the resource identifier
+        - Compares the generated IPA Compliant OperationId with the existing OperationId
+    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-107-valid-operation-id'
+    severity: off
+    given: '#UpdateOperationObject'
+    then:
+      function: 'IPA107ValidOperationID'

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

@@ -55,8 +55,23 @@ rules:
     given: '#DeleteOperationObject'
     then:
       function: IPA108DeleteMethodNoRequestBody
+  xgen-IPA-108-valid-operation-id:
+    description: |
+      OperationID should be compliant with IPA-108 Naming guidelines.
+
+      ##### Implementation details
+      Rule checks for the following conditions:
+        - Applies to all DELETE methods for single resource endpoints (with path parameters)
+        - Generates the expected OperationId given the resource identifier
+        - Compares the generated IPA Compliant OperationId with the existing OperationId
+    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-108-valid-operation-id'
+    severity: off
+    given: '#DeleteOperationObject'
+    then:
+      function: 'IPA108ValidOperationID'
 
 functions:
   - IPA108DeleteMethodResponseShouldNotHaveSchema
   - IPA108DeleteMethod204Response
   - IPA108DeleteMethodNoRequestBody
+  - IPA108ValidOperationID

tools/spectral/ipa/rulesets/README.md

@@ -273,6 +273,17 @@ Rule checks for the following conditions:
   - Ignores resources without a Get method
   - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
 
+#### xgen-IPA-106-valid-operation-id
+
+ `off` 
+OperationID should be compliant with IPA-106 Naming guidelines.
+
+##### Implementation details
+Rule checks for the following conditions:
+  - Applies only to POST methods on resource collection paths
+  - Generates the expected OperationId given the resource identifier
+  - Compares the generated IPA Compliant OperationId with the existing OperationId
+
 
 
 ### IPA-107
@@ -344,6 +355,17 @@ Rule checks for the following conditions:
   - Validation only applies to schema references to a predefined schema (not inline)
   - Confirms the referenced schema name ends with "Request" suffix
 
+#### xgen-IPA-107-valid-operation-id
+
+ `off` 
+OperationID should be compliant with IPA-107 Naming guidelines.
+
+##### Implementation details
+Rule checks for the following conditions:
+  - Validation checks the PATCH/PUT methods for single resource paths and [singleton resources](https://go/ipa/113).
+  - Generates the expected OperationId given the resource identifier
+  - Compares the generated IPA Compliant OperationId with the existing OperationId
+
 
 
 ### IPA-108
@@ -388,6 +410,17 @@ Rule checks for the following conditions:
   - Fails if any requestBody is defined for the DELETE method
   - Skips validation for collection endpoints (without path parameters)
 
+#### xgen-IPA-108-valid-operation-id
+
+ `off` 
+OperationID should be compliant with IPA-108 Naming guidelines.
+
+##### Implementation details
+Rule checks for the following conditions:
+  - Applies to all DELETE methods for single resource endpoints (with path parameters)
+  - Generates the expected OperationId given the resource identifier
+  - Compares the generated IPA Compliant OperationId with the existing OperationId
+
 
 
 ### IPA-109

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

@@ -0,0 +1,38 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
+import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
+import { generateOperationID } from './utils/operationIdGeneration.js';
+
+const RULE_NAME = 'xgen-IPA-106-valid-operation-id';
+const ERROR_MESSAGE =
+  'Invalid OperationID. The Operation ID must start with the verb “create” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form.';
+
+export default (input, _, { path }) => {
+  let resourcePath = path[1];
+  let methodName = 'create';
+
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
+    return;
+  }
+
+  // TODO detect custom method extension - CLOUDP-306294
+
+  if (isCustomMethodIdentifier(resourcePath)) {
+    methodName = getCustomMethodName(resourcePath);
+    resourcePath = stripCustomMethodName(resourcePath);
+  }
+
+  const expectedOperationID = generateOperationID(methodName, resourcePath);
+  if (expectedOperationID !== input.operationId) {
+    const errors = [
+      {
+        path,
+        message: `${ERROR_MESSAGE} Found ${input.operationId}, expected ${expectedOperationID}.`,
+      },
+    ];
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+
+  collectAdoption(path, RULE_NAME);
+};

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

@@ -0,0 +1,38 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
+import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
+import { generateOperationID } from './utils/operationIdGeneration.js';
+
+const RULE_NAME = 'xgen-IPA-107-valid-operation-id';
+const ERROR_MESSAGE =
+  'Invalid OperationID. The Operation ID must start with the verb “update” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. For singleton resources - the last noun may be in plural form.';
+
+export default (input, _, { path }) => {
+  let resourcePath = path[1];
+  let methodName = 'update';
+
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
+    return;
+  }
+
+  // TODO detect custom method extension - CLOUDP-306294
+
+  if (isCustomMethodIdentifier(resourcePath)) {
+    methodName = getCustomMethodName(resourcePath);
+    resourcePath = stripCustomMethodName(resourcePath);
+  }
+
+  const expectedOperationID = generateOperationID(methodName, resourcePath);
+  if (expectedOperationID !== input.operationId) {
+    const errors = [
+      {
+        path,
+        message: `${ERROR_MESSAGE} Found ${input.operationId}, expected ${expectedOperationID}.`,
+      },
+    ];
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+
+  collectAdoption(path, RULE_NAME);
+};

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

@@ -0,0 +1,38 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
+import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
+import { generateOperationID } from './utils/operationIdGeneration.js';
+
+const RULE_NAME = 'xgen-IPA-108-valid-operation-id';
+const ERROR_MESSAGE =
+  'Invalid OperationID. The Operation ID must start with the verb “delete” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form.';
+
+export default (input, _, { path }) => {
+  let resourcePath = path[1];
+  let methodName = 'delete';
+
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
+    return;
+  }
+
+  // TODO detect custom method extension - CLOUDP-306294
+
+  if (isCustomMethodIdentifier(resourcePath)) {
+    methodName = getCustomMethodName(resourcePath);
+    resourcePath = stripCustomMethodName(resourcePath);
+  }
+
+  const expectedOperationID = generateOperationID(methodName, resourcePath);
+  if (expectedOperationID !== input.operationId) {
+    const errors = [
+      {
+        path,
+        message: `${ERROR_MESSAGE} Found ${input.operationId}, expected ${expectedOperationID}.`,
+      },
+    ];
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+
+  collectAdoption(path, RULE_NAME);
+};

tools/spectral/ipa/rulesets/functions/utils/operationIdGeneration.js

@@ -1,4 +1,4 @@
-import { singularize } from 'ember-inflector';
+const inflection = require('inflection');
 import { isPathParam, removePrefix, isSingleResourceIdentifier } from './resourceEvaluation.js';
 
 const CAMEL_CASE = /[A-Z]?[a-z]+/g;
@@ -29,12 +29,12 @@ export function generateOperationID(method, path) {
 
   let opID = verb;
   for (let i = 0; i < nouns.length - 1; i++) {
-    opID += singularize(nouns[i]);
+    opID += inflection.singularize(nouns[i]);
   }
 
   // singularize final noun, dependent on resource identifier
   if (isSingleResourceIdentifier(resourceIdentifier) || verb === 'create') {
-    nouns[nouns.length - 1] = singularize(nouns[nouns.length - 1]);
+    nouns[nouns.length - 1] = inflection.singularize(nouns[nouns.length - 1]);
   }
 
   opID += nouns.pop();

tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js

@@ -57,6 +57,10 @@ export function getCustomMethodName(path) {
   return path.split(':')[1];
 }
 
+export function stripCustomMethodName(path) {
+  return path.substring(0, path.indexOf(':'));
+}
+
 export function isPathParam(string) {
   return string.startsWith('{') && string.endsWith('}');
 }