rule name fix

Author: yelizhenden-mdb

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

@@ -67,21 +67,40 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
             },
           },
         },
+        '/resource3/{id}': {
+          get: {
+            responses: {
+              200: {},
+              201: {},
+              400: {},
+              500: {},
+            },
+          },
+        },
       },
     },
     errors: [
       {
-        code: 'xgen-IPA-104-get-method-response-code-should-be-200-OK',
-        message: 'The HTTP response status code for get operations should be 200 OK. http://go/ipa/104',
+        code: 'xgen-IPA-104-get-method-response-code-is-200-OK',
+        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-should-be-200-OK',
-        message: 'The HTTP response status code for get operations should be 200 OK. http://go/ipa/104',
+        code: 'xgen-IPA-104-get-method-response-code-is-200-OK',
+        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',
+        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'],
+        severity: DiagnosticSeverity.Warning,
+      },
     ],
   },
   {
@@ -96,7 +115,7 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
               500: {},
             },
             'x-xgen-IPA-exception': {
-              'xgen-IPA-104-get-method-response-code-should-be-200-OK': 'reason',
+              'xgen-IPA-104-get-method-response-code-is-200-OK': 'reason',
             },
           },
         },
@@ -107,7 +126,7 @@ testRule('xgen-IPA-104-get-method-response-code-is-200-OK', [
               500: {},
             },
             'x-xgen-IPA-exception': {
-              'xgen-IPA-104-get-method-response-code-should-be-200-OK': 'reason',
+              'xgen-IPA-104-get-method-response-code-is-200-OK': 'reason',
             },
           },
         },

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

@@ -24,7 +24,7 @@ rules:
       function: 'getMethodReturnsSingleResource'
 
   xgen-IPA-104-get-method-response-code-is-200-OK:
-    description: 'The HTTP response status code for GET operations should be 200 OK. http://go/ipa/104'
+    description: 'The Get method must return a 200 OK response. http://go/ipa/104'
     message: '{{error}} http://go/ipa/104'
     severity: warn
     given: '$.paths[*].get'

tools/spectral/ipa/rulesets/README.md

@@ -32,7 +32,7 @@ For rule definitions, see [IPA-104.yaml](https://github.com/mongodb/openapi/blob
 | ----------------------------------------------- | ----------------------------------------------------------------------------------------- | -------- |
 | xgen-IPA-104-resource-has-GET                   | APIs must provide a get method for resources. http://go/ipa/104                           | warn     |
 | xgen-IPA-104-get-method-returns-single-resource | The purpose of the get method is to return data from a single resource. http://go/ipa/104 | warn     |
-| xgen-IPA-104-get-method-response-code-is-200-OK | The HTTP response status code for GET operations should be 200 OK. http://go/ipa/104      | warn     |
+| xgen-IPA-104-get-method-response-code-is-200-OK | The Get method must return a 200 OK response. http://go/ipa/104                           | warn     |
 
 ### IPA-109
 
@@ -58,3 +58,5 @@ For rule definitions, see [IPA-123.yaml](https://github.com/mongodb/openapi/blob
 | Rule Name                                         | Description                                             | Severity |
 | ------------------------------------------------- | ------------------------------------------------------- | -------- |
 | xgen-IPA-123-enum-values-must-be-upper-snake-case | Enum values must be UPPER_SNAKE_CASE. http://go/ipa/123 | warn     |
+
+

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

@@ -2,22 +2,28 @@ import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-104-get-method-response-code-is-200-OK';
-const ERROR_MESSAGE = 'The HTTP response status code for GET operations should be 200 OK.';
+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 }) => {
-  console.log(input);
-
   if (hasException(input, RULE_NAME)) {
     collectException(input, RULE_NAME, path);
     return;
   }
 
   if (input['responses']) {
     const responses = input['responses'];
+
+    // If there is no 200 response, return a violation
     if (!responses['200']) {
       return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE);
     }
+
+    // If there are other 2xx responses that are not 200, return a violation
+    if (Object.keys(responses).some((key) => key.startsWith('2') && key !== '200')) {
+      return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE);
+    }
   }
-  console.log('adoption');
+
   collectAdoption(path, RULE_NAME);
 };

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

@@ -9,7 +9,6 @@ export const EXCEPTION_EXTENSION = 'x-xgen-IPA-exception';
  */
 export function hasException(object, ruleName) {
   if (object[EXCEPTION_EXTENSION]) {
-    console.log('exception');
     return Object.keys(object[EXCEPTION_EXTENSION]).includes(ruleName);
   }
   return false;