fix: format

Author: wtrocki

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

@@ -38,7 +38,7 @@ testRule('xgen-IPA-108-delete-method-return-204-response', [
       {
         code: 'xgen-IPA-108-delete-method-return-204-response',
         message: 'DELETE method should return 204 No Content status code http://go/ipa/108',
-        path: ['paths', '/resource/{id}'],
+        path: ['paths', '/resource/{id}', 'delete'],
         severity: DiagnosticSeverity.Error,
       },
     ],

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

@@ -37,7 +37,7 @@ testRule('xgen-IPA-108-delete-include-404-response', [
       {
         code: 'xgen-IPA-108-delete-include-404-response',
         message: 'DELETE method should include 404 status code for not found resources http://go/ipa/108',
-        path: ['paths', '/resource/{id}'],
+        path: ['paths', '/resource/{id}', 'delete'],
         severity: DiagnosticSeverity.Error,
       },
     ],

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

@@ -25,7 +25,7 @@ testRule('xgen-IPA-108-delete-request-no-body', [
           delete: {
             requestBody: {
               content: {
-                'application/json': {
+                'application/vnd.atlas.2024-08-05+json': {
                   schema: { type: 'object' },
                 },
               },
@@ -41,7 +41,7 @@ testRule('xgen-IPA-108-delete-request-no-body', [
       {
         code: 'xgen-IPA-108-delete-request-no-body',
         message: 'DELETE method should not have a request body http://go/ipa/108',
-        path: ['paths', '/resource/{id}'],
+        path: ['paths', '/resource/{id}', 'delete'],
         severity: DiagnosticSeverity.Error,
       },
     ],

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

@@ -40,7 +40,7 @@ testRule('xgen-IPA-108-delete-response-should-be-empty', [
       {
         code: 'xgen-IPA-108-delete-response-should-be-empty',
         message: 'DELETE method should return an empty response http://go/ipa/108',
-        path: ['paths', '/resource/{id}'],
+        path: ['paths', '/resource/{id}', 'delete'],
         severity: DiagnosticSeverity.Error,
       },
     ],

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

@@ -6,15 +6,15 @@ rules:
     description: Delete method response must be empty http://go/ipa/108
     message: '{{error}} http://go/ipa/108'
     severity: warn
-    given: $.paths[*].delete
+    given: $.paths
     then:
       function: deleteMethodResponseShouldBeVoid
 
   xgen-IPA-108-delete-method-return-204-response:
     description: DELETE method must return 204 No Content
     message: '{{error}} http://go/ipa/108'
     severity: warn
-    given: $.paths[*].delete
+    given: $.paths
     then:
       function: deleteMethod204Response
 
@@ -30,7 +30,7 @@ rules:
     description: DELETE method must include 404 response
     message: '{{error}} http://go/ipa/108'
     severity: warn
-    given: $.paths[*].delete
+    given: $.paths
     then:
       function: deleteMethod404Response
 

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

@@ -1,18 +1,29 @@
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
 import { hasException } from './utils/exceptions.js';
 
-const RULE_NAME = 'xgen-IPA-108-delete-204-response';
+const RULE_NAME = 'xgen-IPA-108-delete-method-return-204-response';
 const ERROR_MESSAGE = 'DELETE method should return 204 No Content status code';
 
-export default (deleteOp, _, { path }) => {
-  if (hasException(deleteOp, RULE_NAME)) {
-    return collectException(deleteOp, RULE_NAME, path);
-  }
+export default (paths, _, { path }) => {
+  const errors = [];
 
-  const responses = deleteOp.responses || {};
-  if (!responses['204']) {
-    return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE);
-  }
+  Object.entries(paths).forEach(([pathUrl, pathItem]) => {
+    const deleteOp = pathItem.delete;
+    if (!deleteOp) return;
 
-  collectAdoption(path, RULE_NAME);
+    if (hasException(deleteOp, RULE_NAME)) {
+      errors.push(collectException(deleteOp, RULE_NAME, `${path}.${pathUrl}.delete`));
+      return;
+    }
+
+    const responses = deleteOp.responses || {};
+    if (!responses['204']) {
+      errors.push(collectAndReturnViolation(`${path}.${pathUrl}.delete`, RULE_NAME, ERROR_MESSAGE));
+      return;
+    }
+
+    collectAdoption(`${path}.${pathUrl}.delete`, RULE_NAME);
+  });
+
+  return errors;
 };

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

@@ -1,18 +1,29 @@
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
 import { hasException } from './utils/exceptions.js';
 
-const RULE_NAME = 'xgen-IPA-108-delete-404-response';
+const RULE_NAME = 'xgen-IPA-108-delete-include-404-response';
 const ERROR_MESSAGE = 'DELETE method should include 404 status code for not found resources';
 
-export default (deleteOp, _, { path }) => {
-  if (hasException(deleteOp, RULE_NAME)) {
-    return collectException(deleteOp, RULE_NAME, path);
-  }
+export default (paths, _, { path }) => {
+  const errors = [];
 
-  const responses = deleteOp.responses || {};
-  if (!responses['404']) {
-    return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE);
-  }
+  Object.entries(paths).forEach(([pathUrl, pathItem]) => {
+    const deleteOp = pathItem.delete;
+    if (!deleteOp) return;
 
-  collectAdoption(path, RULE_NAME);
+    if (hasException(deleteOp, RULE_NAME)) {
+      errors.push(collectException(deleteOp, RULE_NAME, `${path}.${pathUrl}.delete`));
+      return;
+    }
+
+    const responses = deleteOp.responses || {};
+    if (!responses['404']) {
+      errors.push(collectAndReturnViolation(`${path}.${pathUrl}.delete`, RULE_NAME, ERROR_MESSAGE));
+      return;
+    }
+
+    collectAdoption(`${path}.${pathUrl}.delete`, RULE_NAME);
+  });
+
+  return errors;
 };

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

@@ -1,17 +1,25 @@
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
 import { hasException } from './utils/exceptions.js';
 
-const RULE_NAME = 'xgen-IPA-108-delete-no-body';
+const RULE_NAME = 'xgen-IPA-108-delete-request-no-body';
 const ERROR_MESSAGE = 'DELETE method should not have a request body';
 
 export default (deleteOp, _, { path }) => {
+  if (!deleteOp) return [];
+
+  const errors = [];
+
   if (hasException(deleteOp, RULE_NAME)) {
-    return collectException(deleteOp, RULE_NAME, path);
+    errors.push(collectException(deleteOp, RULE_NAME, path));
+    return errors;
   }
 
   if (deleteOp.requestBody) {
-    return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE);
+    errors.push(collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE));
+    return errors;
   }
 
   collectAdoption(path, RULE_NAME);
+
+  return errors;
 };

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

@@ -1,31 +1,36 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
 
-const RULE_NAME = 'xgen-IPA-108-delete-response-should-be-void';
+const RULE_NAME = 'xgen-IPA-108-delete-response-should-be-empty';
 const ERROR_MESSAGES = {
   NON_EMPTY_RESPONSE: 'DELETE method should return an empty response',
 };
 
-export default (deleteOp, _, { path }) => {
+export default (paths, _, { path }) => {
   const errors = [];
 
-  if (hasException(deleteOp, RULE_NAME)) {
-    return collectException(deleteOp, RULE_NAME, path);
-  }
+  Object.entries(paths).forEach(([pathUrl, pathItem]) => {
+    const deleteOp = pathItem.delete;
+    if (!deleteOp) return;
 
-  const responses = deleteOp.responses || {};
+    if (hasException(deleteOp, RULE_NAME)) {
+      errors.push(...collectException(deleteOp, RULE_NAME, `${path}.${pathUrl}.delete`));
+      return;
+    }
+
+    const responses = deleteOp.responses || {};
+    Object.entries(responses).forEach(([status, response]) => {
+      if (status === '204' && response.content) {
+        errors.push(
+          collectAndReturnViolation(`${path}.${pathUrl}.delete`, RULE_NAME, ERROR_MESSAGES.NON_EMPTY_RESPONSE)
+        );
+      }
+    });
 
-  Object.entries(responses).forEach(([status, response]) => {
-    if (status === '204' && response.content) {
-      errors.push(ERROR_MESSAGES.NON_EMPTY_RESPONSE);
+    if (errors.length === 0) {
+      collectAdoption(`${path}.${pathUrl}.delete`, RULE_NAME);
     }
   });
 
-  if (errors.length === 0) {
-    collectAdoption(path, RULE_NAME);
-  } else {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-
   return errors;
 };