additional checks

Author: yelizhenden-mdb

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

@@ -91,12 +91,34 @@ testRule('xgen-IPA-114-error-responses-refer-to-api-error', [
     errors: [
       {
         code: 'xgen-IPA-114-error-responses-refer-to-api-error',
-        message: '400 response must define a schema referencing ApiError',
+        message: '400 response must define a schema referencing ApiError.',
         path: ['paths', '/resources', 'get', 'responses', '400', 'content', 'application/json'],
         severity: DiagnosticSeverity.Warning,
       },
     ],
   },
+  {
+    name: 'invalid error responses missing content',
+    document: {
+      paths: {
+        '/resources': {
+          get: {
+            responses: {
+              400: {},
+            },
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-114-error-responses-refer-to-api-error',
+        message: '400 response must define content with ApiError schema reference.',
+        path: ['paths', '/resources', 'get', 'responses', '400'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
   {
     name: 'invalid error responses referencing wrong schema',
     document: {
@@ -133,7 +155,7 @@ testRule('xgen-IPA-114-error-responses-refer-to-api-error', [
     errors: [
       {
         code: 'xgen-IPA-114-error-responses-refer-to-api-error',
-        message: '500 response must reference ApiError schema',
+        message: '500 response must reference ApiError schema.',
         path: ['paths', '/resources', 'get', 'responses', '500', 'content', 'application/json'],
         severity: DiagnosticSeverity.Warning,
       },
@@ -168,7 +190,7 @@ testRule('xgen-IPA-114-error-responses-refer-to-api-error', [
     errors: [
       {
         code: 'xgen-IPA-114-error-responses-refer-to-api-error',
-        message: '404 response must reference ApiError schema',
+        message: '404 response must reference ApiError schema.',
         path: ['paths', '/resources', 'get', 'responses', '404', 'content', 'application/json'],
         severity: DiagnosticSeverity.Warning,
       },
@@ -193,6 +215,11 @@ testRule('xgen-IPA-114-error-responses-refer-to-api-error', [
                   },
                 },
               },
+              500: {
+                'x-xgen-IPA-exception': {
+                  'xgen-IPA-114-error-responses-refer-to-api-error': 'Reason',
+                },
+              },
             },
           },
         },

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

@@ -18,17 +18,27 @@ const RULE_NAME = 'xgen-IPA-114-error-responses-refer-to-api-error';
  * @param {object} context - The context object containing path and document information
  */
 export default (input, _, { path, documentInventory }) => {
-  const oas = documentInventory.unresolved;
-  const apiResponseObject = resolveObject(oas, path);
-  const errorCode = path[path.length - 1]; // e.g., "400", "404", "500"
+  try {
+    const oas = documentInventory.unresolved;
+    const apiResponseObject = resolveObject(oas, path);
+    const errorCode = path[path.length - 1];
+
+    // Check for exception at response level
+    if (hasException(apiResponseObject, RULE_NAME)) {
+      collectException(apiResponseObject, RULE_NAME, path);
+      return;
+    }
 
-  const errors = checkViolationsAndReturnErrors(apiResponseObject, oas, path, errorCode);
+    const errors = checkViolationsAndReturnErrors(apiResponseObject, oas, path, errorCode);
+    if (errors.length !== 0) {
+      return collectAndReturnViolation(path, RULE_NAME, errors);
+    }
 
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
+    collectAdoption(path, RULE_NAME);
+  } catch(e) {
+    handleInternalError(RULE_NAME, path, e);
   }
 
-  collectAdoption(path, RULE_NAME);
 };
 
 function checkViolationsAndReturnErrors(apiResponseObject, oas, path, errorCode) {
@@ -42,6 +52,8 @@ function checkViolationsAndReturnErrors(apiResponseObject, oas, path, errorCode)
       const schemaName = getSchemaNameFromRef(apiResponseObject.$ref);
       const responseSchema = resolveObject(oas, ['components', 'responses', schemaName]);
       content = responseSchema.content;
+    } else {
+      return [{ path, message: `${errorCode} response must define content with ApiError schema reference.` }];
     }
 
     for (const [mediaType, mediaTypeObj] of Object.entries(content)) {
@@ -57,20 +69,21 @@ function checkViolationsAndReturnErrors(apiResponseObject, oas, path, errorCode)
       const contentPath = [...path, 'content', mediaType];
 
       // Check if schema exists
-      if (!mediaTypeObj || !mediaTypeObj.schema) {
+      if (!mediaTypeObj.schema) {
         errors.push({
           path: contentPath,
-          message: `${errorCode} response must define a schema referencing ApiError`,
+          message: `${errorCode} response must define a schema referencing ApiError.`,
         });
         continue;
       }
 
       // Check if schema references ApiError
       const schema = mediaTypeObj.schema;
+
       if (!schema.$ref || !schema.$ref.endsWith('/ApiError')) {
         errors.push({
           path: contentPath,
-          message: `${errorCode} response must reference ApiError schema`,
+          message: `${errorCode} response must reference ApiError schema.`,
         });
       }
     }