fix: spec for IPA 108

Author: wtrocki

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

@@ -20,6 +20,44 @@ testRule('xgen-IPA-108-delete-include-404-response', [
     },
     errors: [],
   },
+  {
+    name: 'invalid DELETE with no responses',
+    document: {
+      paths: {
+        '/resource/{id}': {
+          delete: {},
+        },
+      },
+    },
+    errors: [
+      {
+        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}', 'delete'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+  {
+    name: 'invalid empty responses',
+    document: {
+      paths: {
+        '/resource/{id}': {
+          delete: {
+            responses: {},
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        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}', 'delete'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
   {
     name: 'invalid DELETE missing 404',
     document: {
@@ -36,7 +74,7 @@ testRule('xgen-IPA-108-delete-include-404-response', [
     errors: [
       {
         code: 'xgen-IPA-108-delete-include-404-response',
-        message: 'DELETE method should include 404 status code for not found resources http://go/ipa/108',
+        message: 'DELETE method should include 404 status code for not found resources. http://go/ipa/108',
         path: ['paths', '/resource/{id}', 'delete'],
         severity: DiagnosticSeverity.Warning,
       },

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

@@ -26,16 +26,7 @@ rules:
     then:
       function: deleteMethod404Response
 
-  xgen-IPA-108-delete-request-no-body:
-    description: DELETE method must not have request body
-    message: '{{error}} http://go/ipa/108'
-    severity: warn
-    given: $.paths[*].delete
-    then:
-      function: deleteMethodNoRequestBody
-
 functions:
   - deleteMethodResponseShouldNotHaveSchema
   - deleteMethod204Response
-  - deleteMethodNoRequestBody
   - deleteMethod404Response

tools/spectral/ipa/rulesets/README.md

@@ -54,6 +54,7 @@ For rule definitions, see [IPA-108.yaml](https://github.com/mongodb/openapi/blob
 | ---------------------------------------------- | ------------------------------------------------------------------------------------ | -------- |
 | xgen-IPA-108-delete-response-should-be-empty   | Delete method response should not have schema reference to object. http://go/ipa/108 | warn     |
 | xgen-IPA-108-delete-method-return-204-response | DELETE method must return 204 No Content. http://go/ipa/108                          | warn     |
+| xgen-IPA-108-delete-include-404-response       | DELETE method must include 404 response and return it when resource not found        | warn     |
 
 ### IPA-109
 

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

@@ -2,7 +2,7 @@ import { collectAdoption, collectAndReturnViolation, collectException } from './
 import { hasException } from './utils/exceptions.js';
 
 const RULE_NAME = 'xgen-IPA-108-delete-include-404-response';
-const ERROR_MESSAGE = 'DELETE method should include 404 status code for not found resources';
+const ERROR_MESSAGE = 'DELETE method should include 404 status code for not found resources.';
 
 /**
  * Delete method should include 404 status code for not found resources
@@ -12,18 +12,14 @@ const ERROR_MESSAGE = 'DELETE method should include 404 status code for not foun
  * @param {object} context - The context object containing the path
  */
 export default (input, _, { path }) => {
-  const deleteOp = input;
-  if (!deleteOp) return;
-
-  if (hasException(deleteOp, RULE_NAME)) {
-    collectException(deleteOp, RULE_NAME, path);
+  const responses = input.responses;
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
     return;
   }
 
-  const responses = deleteOp.responses || {};
-  if (!responses['404']) {
+  if (!responses || !responses['404']) {
     return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE);
   }
-
-  collectAdoption(path, RULE_NAME);
+  return collectAdoption(path, RULE_NAME);
 };