CLOUDP-302982: Fix

lovisaberggren · lovisaberggren · commit a2e127cb3c26 · 2025-03-06T14:51:54.000Z
diff --git a/tools/spectral/ipa/__tests__/getMethodReturnsResponseSuffixedObject.test.js b/tools/spectral/ipa/__tests__/getMethodReturnsResponseSuffixedObject.test.js
@@ -3,19 +3,11 @@ import { DiagnosticSeverity } from '@stoplight/types';
 
 const componentSchemas = {
   schemas: {
-    ExampleResponse: {
-      properties: {
-        exampleProperty: {
-          type: 'string',
-        },
-      },
+    SchemaResponse: {
+      type: 'object',
     },
-    ExampleRequest: {
-      properties: {
-        exampleProperty: {
-          type: 'string',
-        },
-      },
+    Schema: {
+      type: 'object',
     },
   },
 };
@@ -25,22 +17,44 @@ testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [
     name: 'valid schema names names',
     document: {
       paths: {
-        '/resource1/{id}': {
+        '/resource/{id}': {
           get: {
             responses: {
               200: {
                 content: {
-                  'application/vnd.atlas.2024-08-05+json': {
+                  'application/vnd.atlas.2023-01-01+json': {
+                    schema: {
+                      $ref: '#/components/schemas/SchemaResponse',
+                    },
+                  },
+                  'application/vnd.atlas.2024-01-01+json': {
+                    schema: {
+                      $ref: '#/components/schemas/SchemaResponse',
+                    },
+                  },
+                  'application/vnd.atlas.2025-01-01+json': {
+                    schema: {
+                      type: 'array',
+                      items: {
+                        $ref: '#/components/schemas/SchemaResponse',
+                      },
+                    },
+                  },
+                },
+              },
+              400: {
+                content: {
+                  'application/vnd.atlas.2023-01-01+json': {
                     schema: {
-                      $ref: '#/components/schemas/ExampleResponse',
+                      $ref: '#/components/schemas/Schema',
                     },
                   },
                 },
               },
             },
           },
         },
-        '/resource2/{id}': {
+        '/resourceTwo/{id}': {
           get: {
             responses: {
               200: {
@@ -53,14 +67,14 @@ testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [
             },
           },
         },
-        '/singleton': {
+        '/resource/{id}/singleton': {
           get: {
             responses: {
               200: {
                 content: {
                   'application/vnd.atlas.2024-08-05+json': {
                     schema: {
-                      $ref: '#/components/schemas/ExampleResponse',
+                      $ref: '#/components/schemas/SchemaResponse',
                     },
                   },
                 },
@@ -82,24 +96,37 @@ testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [
             responses: {
               200: {
                 content: {
-                  'application/vnd.atlas.2024-08-05+json': {
+                  'application/vnd.atlas.2023-01-01+json': {
                     schema: {
-                      $ref: '#/components/schemas/ExampleRequest',
+                      $ref: '#/components/schemas/Schema',
+                    },
+                  },
+                  'application/vnd.atlas.2024-01-01+json': {
+                    schema: {
+                      $ref: '#/components/schemas/Schema',
+                    },
+                  },
+                  'application/vnd.atlas.2025-01-01+json': {
+                    schema: {
+                      type: 'array',
+                      items: {
+                        $ref: '#/components/schemas/Schema',
+                      },
                     },
                   },
                 },
               },
             },
           },
         },
-        '/singleton': {
+        '/resource/{id}/singleton': {
           get: {
             responses: {
               200: {
                 content: {
                   'application/vnd.atlas.2024-08-05+json': {
                     schema: {
-                      $ref: '#/components/schemas/ExampleRequest',
+                      $ref: '#/components/schemas/Schema',
                     },
                   },
                 },
@@ -113,22 +140,58 @@ testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [
     errors: [
       {
         code: 'xgen-IPA-104-get-method-returns-response-suffixed-object',
-        message: 'ExampleRequest schema name should end in "Response". http://go/ipa/104',
+        message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104',
         path: [
           'paths',
           '/resource/{id}',
           'get',
           'responses',
           '200',
           'content',
-          'application/vnd.atlas.2024-08-05+json',
+          'application/vnd.atlas.2023-01-01+json',
         ],
         severity: DiagnosticSeverity.Warning,
       },
       {
         code: 'xgen-IPA-104-get-method-returns-response-suffixed-object',
-        message: 'ExampleRequest schema name should end in "Response". http://go/ipa/104',
-        path: ['paths', '/singleton', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2024-08-05+json'],
+        message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104',
+        path: [
+          'paths',
+          '/resource/{id}',
+          'get',
+          'responses',
+          '200',
+          'content',
+          'application/vnd.atlas.2024-01-01+json',
+        ],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        code: 'xgen-IPA-104-get-method-returns-response-suffixed-object',
+        message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104',
+        path: [
+          'paths',
+          '/resource/{id}',
+          'get',
+          'responses',
+          '200',
+          'content',
+          'application/vnd.atlas.2025-01-01+json',
+        ],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        code: 'xgen-IPA-104-get-method-returns-response-suffixed-object',
+        message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104',
+        path: [
+          'paths',
+          '/resource/{id}/singleton',
+          'get',
+          'responses',
+          '200',
+          'content',
+          'application/vnd.atlas.2024-08-05+json',
+        ],
         severity: DiagnosticSeverity.Warning,
       },
     ],
@@ -142,20 +205,39 @@ testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [
             responses: {
               200: {
                 content: {
-                  'application/vnd.atlas.2024-08-05+json': {
+                  'application/vnd.atlas.2023-01-01+json': {
+                    'x-xgen-IPA-exception': {
+                      'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason',
+                    },
+                    schema: {
+                      $ref: '#/components/schemas/Schema',
+                    },
+                  },
+                  'application/vnd.atlas.2024-01-01+json': {
+                    'x-xgen-IPA-exception': {
+                      'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason',
+                    },
+                    schema: {
+                      $ref: '#/components/schemas/Schema',
+                    },
+                  },
+                  'application/vnd.atlas.2025-01-01+json': {
                     'x-xgen-IPA-exception': {
                       'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason',
                     },
                     schema: {
-                      $ref: '#/components/schemas/ExampleRequest',
+                      type: 'array',
+                      items: {
+                        $ref: '#/components/schemas/Schema',
+                      },
                     },
                   },
                 },
               },
             },
           },
         },
-        '/singleton': {
+        '/resource/{id}/singleton': {
           get: {
             responses: {
               200: {
@@ -165,7 +247,7 @@ testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [
                       'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason',
                     },
                     schema: {
-                      $ref: '#/components/schemas/ExampleRequest',
+                      $ref: '#/components/schemas/Schema',
                     },
                   },
                 },
diff --git a/tools/spectral/ipa/rulesets/IPA-104.yaml b/tools/spectral/ipa/rulesets/IPA-104.yaml
@@ -34,6 +34,7 @@ rules:
     description: 'The get method of a resource should return a "Response" suffixed object. http://go/ipa/104'
     message: '{{error}} http://go/ipa/104'
     severity: warn
-    given: '$.paths[*].get'
+    given: '$.paths[*].get.responses[*].content'
     then:
+      field: '@key'
       function: 'getMethodReturnsResponseSuffixedObject'
diff --git a/tools/spectral/ipa/rulesets/functions/createMethodRequestBodyIsRequestSuffixedObject.js b/tools/spectral/ipa/rulesets/functions/createMethodRequestBodyIsRequestSuffixedObject.js
@@ -2,6 +2,7 @@ import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
 import { isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
 import { resolveObject } from './utils/componentUtils.js';
+import { getSchemaRef } from './utils/methodUtils.js';
 
 const RULE_NAME = 'xgen-IPA-106-create-method-request-body-is-request-suffixed-object';
 const ERROR_MESSAGE_SCHEMA_NAME = 'The response body schema must reference a schema with a Request suffix.';
@@ -23,25 +24,15 @@ export default (input, _, { path, documentInventory }) => {
   }
 
   if (contentPerMediaType.schema) {
+    console.log(contentPerMediaType);
     const schema = contentPerMediaType.schema;
-    if (schema.type === 'array' && schema.items) {
-      let schemaItems = schema.items;
-      if (!schemaItems.$ref) {
-        return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_REF);
-      }
-      if (!schemaItems.$ref.endsWith('Request')) {
-        return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_NAME);
-      }
-    } else {
-      if (!schema.$ref) {
-        return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_REF);
-      }
-
-      if (!schema.$ref.endsWith('Request')) {
-        return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_NAME);
-      }
+    const schemaName = getSchemaRef(schema);
+    if (!schemaName) {
+      return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_REF);
+    }
+    if (!schemaName.endsWith('Request')) {
+      return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_NAME);
     }
-
     collectAdoption(path, RULE_NAME);
   }
 };
diff --git a/tools/spectral/ipa/rulesets/functions/getMethodReturnsResponseSuffixedObject.js b/tools/spectral/ipa/rulesets/functions/getMethodReturnsResponseSuffixedObject.js
@@ -1,48 +1,46 @@
 import {
   isSingleResourceIdentifier,
-  isCustomMethodIdentifier,
   isSingletonResource,
   getResourcePathItems,
+  isResourceCollectionIdentifier,
 } from './utils/resourceEvaluation.js';
-import { getAllSuccessfulResponseSchemaNames } from './utils/methodUtils.js';
 import { resolveObject } from './utils/componentUtils.js';
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import { getSchemaRef } from './utils/methodUtils.js';
 
 const RULE_NAME = 'xgen-IPA-104-get-method-returns-response-suffixed-object';
-const ERROR_MESSAGE = 'schema name should end in "Response".';
+const ERROR_MESSAGE_SCHEMA_NAME = 'The request schema must reference a schema with a Response suffix.';
+const ERROR_MESSAGE_SCHEMA_REF = 'The response body schema is defined inline and must reference a predefined schema.';
 
-export default (input, _, { path, document }) => {
+export default (input, _, { path, documentInventory }) => {
   const resourcePath = path[1];
-  const oas = document.data;
+  const responseCode = path[4];
+  const oas = documentInventory.unresolved;
   const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
 
   if (
-    isCustomMethodIdentifier(resourcePath) ||
-    (!isSingleResourceIdentifier(resourcePath) && !isSingletonResource(resourcePaths))
+    responseCode.startsWith('2') ||
+    isResourceCollectionIdentifier(resourcePath) ||
+    (isSingleResourceIdentifier(resourcePath) && isSingletonResource(resourcePaths))
   ) {
-    return;
-  }
-
-  const errors = [];
-
-  const responseSchemaNames = getAllSuccessfulResponseSchemaNames(oas.paths[resourcePath].get);
-  responseSchemaNames.forEach(({ schemaName, schemaPath }) => {
-    const fullPath = path.concat(schemaPath);
-    const responseObject = resolveObject(oas, fullPath);
+    const contentPerMediaType = resolveObject(oas, path);
 
-    if (hasException(responseObject, RULE_NAME)) {
-      collectException(responseObject, RULE_NAME, fullPath);
-    } else if (!schemaName.endsWith('Response')) {
-      collectAndReturnViolation(fullPath, RULE_NAME, `${schemaName} ${ERROR_MESSAGE}`);
-      errors.push({
-        path: fullPath,
-        message: `${schemaName} ${ERROR_MESSAGE}`,
-      });
-    } else {
-      collectAdoption(fullPath, RULE_NAME);
+    if (hasException(contentPerMediaType, RULE_NAME)) {
+      collectException(contentPerMediaType, RULE_NAME, path);
+      return;
     }
-  });
 
-  return errors;
+    if (contentPerMediaType.schema) {
+      const schema = contentPerMediaType.schema;
+      const schemaName = getSchemaRef(schema);
+      if (!schemaName) {
+        return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_REF);
+      }
+      if (!schemaName.endsWith('Response')) {
+        return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_NAME);
+      }
+      collectAdoption(path, RULE_NAME);
+    }
+  }
 };
diff --git a/tools/spectral/ipa/rulesets/functions/utils/methodUtils.js b/tools/spectral/ipa/rulesets/functions/utils/methodUtils.js
