CLOUDP-328959: Added early returns and removed reference to custom methods

Author: Sophia Marie Terry

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

@@ -1,15 +1,22 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
-import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
+import { isCustomMethodIdentifier, isResourceCollectionIdentifier, isSingletonResource, getResourcePathItems } 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';
+export default (input, _, { path, documentInventory }) => {
+  const resourcePath = path[1];
+  const oas = documentInventory.resolved;
+  const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
+  const methodName = 'create';
+
+  const isResourceCollection = isResourceCollectionIdentifier(resourcePath) && !isSingletonResource(resourcePaths);
+  if (isCustomMethodIdentifier(resourcePath) || !isResourceCollection) {
+    return;
+  }
 
   if (hasException(input, RULE_NAME)) {
     collectException(input, RULE_NAME, path);
@@ -18,11 +25,6 @@ export default (input, _, { path }) => {
 
   // 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 = [

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

@@ -1,15 +1,24 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
-import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
+import { isSingleResourceIdentifier, isResourceCollectionIdentifier, isSingletonResource, getResourcePathItems } 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';
+export default (input, _, { path, documentInventory }) => {
+  const resourcePath = path[1];
+  const oas = documentInventory.resolved;
+  const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
+  const methodName = 'update';
+
+  if (
+    !isSingleResourceIdentifier(resourcePath) &&
+    !(isResourceCollectionIdentifier(resourcePath) && isSingletonResource(resourcePaths))
+  ) {
+    return;
+  }
 
   if (hasException(input, RULE_NAME)) {
     collectException(input, RULE_NAME, path);
@@ -18,11 +27,6 @@ export default (input, _, { path }) => {
 
   // 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 = [

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

@@ -1,15 +1,19 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
-import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
+import { isSingleResourceIdentifier } 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';
+export default (input, _, { path, }) => {
+  const resourcePath = path[1];
+  const methodName = 'delete';
+
+  if (!isSingleResourceIdentifier(resourcePath)) {
+    return;
+  }
 
   if (hasException(input, RULE_NAME)) {
     collectException(input, RULE_NAME, path);
@@ -18,11 +22,6 @@ export default (input, _, { path }) => {
 
   // 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 = [