CLOUDP-304938: Error for create is get rule missing get schema

Author: lovisaberggren

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

@@ -318,6 +318,31 @@ testRule('xgen-IPA-106-create-method-request-body-is-get-method-response', [
             },
           },
         },
+        // Missing schema for Get method
+        '/resourceFour': {
+          post: {
+            requestBody: {
+              content: {
+                'application/vnd.atlas.2023-01-01+json': {
+                  schema: {
+                    $ref: '#/components/schemas/SchemaOne',
+                  },
+                },
+              },
+            },
+          },
+        },
+        '/resourceFour/{id}': {
+          get: {
+            responses: {
+              200: {
+                content: {
+                  'application/vnd.atlas.2023-01-01+json': {},
+                },
+              },
+            },
+          },
+        },
         '/resourceCircular': {
           post: {
             requestBody: {
@@ -389,6 +414,13 @@ testRule('xgen-IPA-106-create-method-request-body-is-get-method-response', [
         path: ['paths', '/resourceThree', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
         severity: DiagnosticSeverity.Warning,
       },
+      {
+        code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
+        message:
+          'Could not validate that the Create request body schema matches the response schema of the Get method. The Get method does not have a schema. http://go/ipa/106',
+        path: ['paths', '/resourceFour', 'post', 'requestBody', 'content', 'application/vnd.atlas.2023-01-01+json'],
+        severity: DiagnosticSeverity.Warning,
+      },
       {
         code: 'xgen-IPA-106-create-method-request-body-is-get-method-response',
         message:

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

@@ -26,7 +26,7 @@ export default (input, opts, { path, documentInventory }) => {
   }
 
   const getMethodResponseContentPerMediaType = getResponseOfGetMethodByMediaType(mediaType, resourcePath, oas);
-  if (!getMethodResponseContentPerMediaType || !getMethodResponseContentPerMediaType.schema) {
+  if (!getMethodResponseContentPerMediaType) {
     return;
   }
 
@@ -62,14 +62,22 @@ function checkViolationsAndReturnErrors(
   const errors = [];
 
   const ignoredValues = opts?.ignoredValues || [];
+  if (!getMethodResponseContentPerMediaType.schema) {
+    return [
+      {
+        path,
+        message: `Could not validate that the Create request body schema matches the response schema of the Get method. The Get method does not have a schema.`,
+      },
+    ];
+  }
   if (
     !isDeepEqual(
       omitDeep(postMethodRequestContentPerMediaType.schema, ...ignoredValues),
       omitDeep(getMethodResponseContentPerMediaType.schema, ...ignoredValues)
     )
   ) {
     errors.push({
-      path: path,
+      path,
       message: ERROR_MESSAGE,
     });
   }