fix(rulesets): operation-success-response rule does not respect 2XX a…

…nd 3XX (#1793)
stoplightio · Aug 31, 2021 · b5c6a8f · b5c6a8f
1 parent 0aa8863
commit b5c6a8f
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 16 deletions.
diff --git a/packages/rulesets/src/oas/__tests__/operation-success-response.test.ts b/packages/rulesets/src/oas/__tests__/operation-success-response.test.ts
@@ -131,4 +131,81 @@ testRule('operation-success-response', [
     },
     errors: [],
   },
+
+  {
+    name: 'oas2 document has 2XX and 3XX responses set',
+    document: {
+      swagger: '2.0',
+      paths: {
+        '/path': {
+          get: {
+            responses: {
+              '3XX': {},
+            },
+          },
+          post: {
+            responses: {
+              '2XX': {},
+            },
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        message: 'Operation must have at least one "2xx" or "3xx" response.',
+        path: ['paths', '/path', 'get', 'responses'],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        message: 'Operation must have at least one "2xx" or "3xx" response.',
+        path: ['paths', '/path', 'post', 'responses'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+
+  {
+    name: 'oas 3.0.x document has 2XX and 3XX responses set',
+    document: {
+      openapi: '3.0.3',
+      paths: {
+        '/path': {
+          get: {
+            responses: {
+              '3XX': {},
+            },
+          },
+          post: {
+            responses: {
+              '2XX': {},
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+
+  {
+    name: 'oas 3.1.x document has 2XX and 3XX responses set',
+    document: {
+      openapi: '3.1.0',
+      paths: {
+        '/path': {
+          get: {
+            responses: {
+              '3XX': {},
+            },
+          },
+          post: {
+            responses: {
+              '2XX': {},
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/packages/rulesets/src/oas/functions/oasOpSuccessResponse.ts b/packages/rulesets/src/oas/functions/oasOpSuccessResponse.ts
@@ -1,22 +1,32 @@
-import type { IFunction } from '@stoplight/spectral-core';
-import { isObject } from './utils/isObject';
+import { createRulesetFunction } from '@stoplight/spectral-core';
+import { oas3 } from '@stoplight/spectral-formats';
 
-export const oasOpSuccessResponse: IFunction = targetVal => {
-  if (!isObject(targetVal)) {
-    return;
-  }
+export const oasOpSuccessResponse = createRulesetFunction<Record<string, unknown>, null>(
+  {
+    input: {
+      type: 'object',
+    },
+    options: null,
+  },
+  (input, opts, context) => {
+    const isOAS3X = context.document.formats?.has(oas3) === true;
+
+    for (const response of Object.keys(input)) {
+      if (isOAS3X && (response === '2XX' || response === '3XX')) {
+        return;
+      }
 
-  for (const response of Object.keys(targetVal)) {
-    if (Number(response) >= 200 && Number(response) < 400) {
-      return;
+      if (Number(response) >= 200 && Number(response) < 400) {
+        return;
+      }
     }
-  }
 
-  return [
-    {
-      message: 'Operation must define at least a single 2xx or 3xx response',
-    },
-  ];
-};
+    return [
+      {
+        message: 'Operation must define at least a single 2xx or 3xx response',
+      },
+    ];
+  },
+);
 
 export default oasOpSuccessResponse;