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/functions/IPA106ValidOperationID.js

@@ -0,0 +1,34 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, 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';
+
+export default (input, _, { path, documentInventory }) => {
+  let resourcePath = path[1];
+  const oas = documentInventory.resolved;
+  let methodName = 'create';
+
+  // TODO detect exceptions
+
+  if (isCustomMethodIdentifier(resourcePath)) {
+    methodName = getCustomMethodName(resourcePath);
+    resourcePath = stripCustomMethodName(resourcePath);
+  }
+
+  let errors = [];
+  const expectedOperationID = generateOperationID(methodName, resourcePath);
+  if (expectedOperationID != input.operationId) {
+    errors.push({
+      path: path,
+      message: `${ERROR_MESSAGE} Found ${input.operationId} expected ${expectedOperationID}.`,
+    });
+  }
+
+  if (errors.length !== 0) {
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+  collectAdoption(path, RULE_NAME);
+};

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

@@ -0,0 +1,34 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, 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';
+
+export default (input, _, { path, documentInventory }) => {
+  let resourcePath = path[1];
+  const oas = documentInventory.resolved;
+  let methodName = 'update';
+
+  // TODO detect exceptions
+
+  if (isCustomMethodIdentifier(resourcePath)) {
+    methodName = getCustomMethodName(resourcePath);
+    resourcePath = stripCustomMethodName(resourcePath);
+  }
+
+  let errors = [];
+  const expectedOperationID = generateOperationID(methodName, resourcePath);
+  if (expectedOperationID != input.operationId) {
+    errors.push({
+      path: path,
+      message: `${ERROR_MESSAGE} Found ${input.operationId} expected ${expectedOperationID}.`,
+    });
+  }
+
+  if (errors.length !== 0) {
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+  collectAdoption(path, RULE_NAME);
+};

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

@@ -0,0 +1,34 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, 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';
+
+export default (input, _, { path, documentInventory }) => {
+  let resourcePath = path[1];
+  const oas = documentInventory.resolved;
+  let methodName = 'delete';
+
+  // TODO detect exceptions
+
+  if (isCustomMethodIdentifier(resourcePath)) {
+    methodName = getCustomMethodName(resourcePath);
+    resourcePath = stripCustomMethodName(resourcePath);
+  }
+
+  let errors = [];
+  const expectedOperationID = generateOperationID(methodName, resourcePath);
+  if (expectedOperationID != input.operationId) {
+    errors.push({
+      path: path,
+      message: `${ERROR_MESSAGE} Found ${input.operationId} expected ${expectedOperationID}.`,
+    });
+  }
+
+  if (errors.length !== 0) {
+    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('}');
 }