CLOUDP-304938: Add error for inline get schema

Author: lovisaberggren

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

@@ -360,6 +360,37 @@ testRule('xgen-IPA-105-list-method-response-is-get-method-response', [
             },
           },
         },
+        // Get without schema ref
+        '/resourceThree': {
+          get: {
+            responses: {
+              200: {
+                content: {
+                  'application/vnd.atlas.2024-01-05+json': {
+                    schema: {
+                      $ref: '#/components/schemas/PaginatedResourceSchema',
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+        '/resourceThree/{id}': {
+          get: {
+            responses: {
+              200: {
+                content: {
+                  'application/vnd.atlas.2024-01-05+json': {
+                    schema: {
+                      type: 'object',
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
       },
       components: componentSchemas,
     },
@@ -393,6 +424,21 @@ testRule('xgen-IPA-105-list-method-response-is-get-method-response', [
         path: ['paths', '/resourceTwo', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2024-01-05+json'],
         severity: DiagnosticSeverity.Warning,
       },
+      {
+        code: 'xgen-IPA-105-list-method-response-is-get-method-response',
+        message:
+          'Could not validate that the List method returns the same resource object as the Get method. The Get method does not have a schema reference. http://go/ipa/105',
+        path: [
+          'paths',
+          '/resourceThree',
+          'get',
+          'responses',
+          '200',
+          'content',
+          'application/vnd.atlas.2024-01-05+json',
+        ],
+        severity: DiagnosticSeverity.Warning,
+      },
     ],
   },
   {

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

@@ -11,12 +11,7 @@ import {
   collectException,
   handleInternalError,
 } from './utils/collectionUtils.js';
-import {
-  getResponseOfListMethodByMediaType,
-  getSchemaRef,
-  getSchemaNameFromRef,
-  getResponseOfGetMethodByMediaType,
-} from './utils/methodUtils.js';
+import { getSchemaRef, getSchemaNameFromRef, getResponseOfGetMethodByMediaType } from './utils/methodUtils.js';
 import { schemaIsPaginated } from './utils/schemaUtils.js';
 
 const RULE_NAME = 'xgen-IPA-105-list-method-response-is-get-method-response';
@@ -39,7 +34,8 @@ export default (input, _, { path, documentInventory }) => {
   }
 
   // Ignore if the List method does not have a response schema
-  const listMethodResponse = getResponseOfListMethodByMediaType(mediaType, resourcePath, oas);
+  const listMethodResponse = oas.paths[resourcePath].get.responses['200'].content[mediaType];
+
   if (!listMethodResponse || !listMethodResponse.schema) {
     return;
   }
@@ -98,6 +94,16 @@ function checkViolationsAndReturnErrors(path, listMethodResultItems, getMethodRe
     const listMethodSchemaRef = getSchemaRef(listMethodResultItems);
     const getMethodSchemaRef = getSchemaRef(getMethodResponseContent.schema);
 
+    // Error if the Get method does not have a schema ref
+    if (!getMethodSchemaRef) {
+      return [
+        {
+          path,
+          message: `Could not validate that the List method returns the same resource object as the Get method. The Get method does not have a schema reference.`,
+        },
+      ];
+    }
+
     // Error if the get method resource is not the same as the list method resource
     if (getMethodSchemaRef !== listMethodSchemaRef) {
       return [{ path, message: ERROR_MESSAGE }];