address the comments

Author: yelizhenden-mdb

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

@@ -1,15 +1,14 @@
 import testRule from './__helpers__/testRule';
 import { DiagnosticSeverity } from '@stoplight/types';
 
-testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
+testRule('xgen-IPA-104-get-method-response-code-is-200', [
   {
     name: 'valid methods',
     document: {
       paths: {
         '/resource': {
           get: {
             responses: {
-              200: {},
               400: {},
               500: {},
             },
@@ -27,7 +26,6 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
         '/resource/{id}:customMethod': {
           get: {
             responses: {
-              200: {},
               400: {},
               500: {},
             },
@@ -36,7 +34,6 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
         '/singleton': {
           get: {
             responses: {
-              200: {},
               400: {},
               500: {},
             },
@@ -50,6 +47,7 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
     name: 'invalid methods',
     document: {
       paths: {
+        '/resource1': { get: { responses: {}}},
         '/resource1/{id}': {
           get: {
             responses: {
@@ -59,6 +57,7 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
             },
           },
         },
+        '/resource2': { get: { responses: {} }},
         '/resource2/{id}': {
           get: {
             responses: {
@@ -67,6 +66,7 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
             },
           },
         },
+        '/resource3': { get: { responses: {}}},
         '/resource3/{id}': {
           get: {
             responses: {
@@ -81,21 +81,21 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
     },
     errors: [
       {
-        code: 'xgen-IPA-104-get-method-response-code-is-200-OK',
+        code: 'xgen-IPA-104-get-method-response-code-is-200',
         message:
           'The Get method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/104',
         path: ['paths', '/resource1/{id}', 'get'],
         severity: DiagnosticSeverity.Warning,
       },
       {
-        code: 'xgen-IPA-104-get-method-response-code-is-200-OK',
+        code: 'xgen-IPA-104-get-method-response-code-is-200',
         message:
           'The Get method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/104',
         path: ['paths', '/resource2/{id}', 'get'],
         severity: DiagnosticSeverity.Warning,
       },
       {
-        code: 'xgen-IPA-104-get-method-response-code-is-200-OK',
+        code: 'xgen-IPA-104-get-method-response-code-is-200',
         message:
           'The Get method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/104',
         path: ['paths', '/resource3/{id}', 'get'],
@@ -107,6 +107,7 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
     name: 'invalid method with exception',
     document: {
       paths: {
+        '/resource1': { get: {responses: {}}},
         '/resource1/{id}': {
           get: {
             responses: {
@@ -115,18 +116,19 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
               500: {},
             },
             'x-xgen-IPA-exception': {
-              'xgen-IPA-104-get-method-response-code-is-200-OK': 'reason',
+              'xgen-IPA-104-get-method-response-code-is-200': 'reason',
             },
           },
         },
+        '/resource2': { get: {responses: {}}},
         '/resource2/{id}': {
           get: {
             responses: {
               400: {},
               500: {},
             },
             'x-xgen-IPA-exception': {
-              'xgen-IPA-104-get-method-response-code-is-200-OK': 'reason',
+              'xgen-IPA-104-get-method-response-code-is-200': 'reason',
             },
           },
         },

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

@@ -23,7 +23,7 @@ rules:
     then:
       function: 'getMethodReturnsSingleResource'
 
-  xgen-IPA-104-get-method-response-code-is-200-OK:
+  xgen-IPA-104-get-method-response-code-is-200:
     description: 'The Get method must return a 200 OK response. http://go/ipa/104'
     message: '{{error}} http://go/ipa/104'
     severity: warn

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

@@ -1,11 +1,21 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import {
+  isChild,
+  isCustomMethod,
+} from './utils/resourceEvaluation.js';
 
-const RULE_NAME = 'xgen-IPA-104-get-method-response-code-is-200-OK';
+const RULE_NAME = 'xgen-IPA-104-get-method-response-code-is-200';
 const ERROR_MESSAGE =
   'The Get method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code.';
 
 export default (input, _, { path }) => {
+  const resourcePath = path[1];
+
+  if (isCustomMethod(resourcePath) || !isChild(resourcePath)) {
+    return;
+  }
+
   if (hasException(input, RULE_NAME)) {
     collectException(input, RULE_NAME, path);
     return;

tools/spectral/ipa/rulesets/functions/utils/methodUtils.js

@@ -1,3 +1,5 @@
+import { schemaIsArray, schemaIsPaginated } from './schemaUtils.js';
+
 /**
  * Returns a list of all successful response schemas for the passed operation, i.e. for any 2xx response.
  *
@@ -29,3 +31,7 @@ export function getAllSuccessfulResponseSchemas(operationObject) {
   });
   return result;
 }
+
+export function returnsSingleResource(schema) {
+  return !schemaIsArray(schema) && !schemaIsPaginated(schema);
+}