CLOUDP-271993: Add rule xgen-IPA-105-list-method-no-request-body

Author: lovisaberggren

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

@@ -0,0 +1,117 @@
+import testRule from './__helpers__/testRule';
+import { DiagnosticSeverity } from '@stoplight/types';
+
+testRule('xgen-IPA-105-list-method-no-request-body', [
+  {
+    name: 'valid list without body',
+    document: {
+      paths: {
+        '/resource': {
+          get: {
+            responses: {
+              200: {},
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+  {
+    name: 'rule ignores singleton and Get',
+    document: {
+      paths: {
+        '/resource': {
+          get: {
+            responses: {
+              200: {},
+            },
+          },
+        },
+        '/resource/{id}': {
+          get: {
+            responses: {
+              200: {},
+            },
+            requestBody: {
+              content: {
+                'application/vnd.atlas.2024-08-05+json': {
+                  schema: { type: 'object' },
+                },
+              },
+            },
+          },
+        },
+        '/resource/{id}/singleton': {
+          get: {
+            responses: {
+              200: {},
+            },
+            requestBody: {
+              content: {
+                'application/vnd.atlas.2024-08-05+json': {
+                  schema: { type: 'object' },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+  {
+    name: 'invalid list with body',
+    document: {
+      paths: {
+        '/resource': {
+          get: {
+            responses: {
+              200: {},
+            },
+            requestBody: {
+              content: {
+                'application/vnd.atlas.2024-08-05+json': {
+                  schema: { type: 'object' },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-105-list-method-no-request-body',
+        message: 'The List method must not include a request body. http://go/ipa/105',
+        path: ['paths', '/resource', 'get'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+  {
+    name: 'invalid with exception',
+    document: {
+      paths: {
+        '/resource': {
+          get: {
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-105-list-method-no-request-body': 'reason',
+            },
+            responses: {
+              200: {},
+            },
+            requestBody: {
+              content: {
+                'application/vnd.atlas.2024-08-05+json': {
+                  schema: { type: 'object' },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+]);

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

@@ -3,6 +3,7 @@
 
 functions:
   - listResponseCodeShouldBe200OK
+  - listMethodHasNoRequestBody
 
 rules:
   xgen-IPA-105-list-method-response-code-is-200:
@@ -12,3 +13,10 @@ rules:
     given: '$.paths[*].get'
     then:
       function: 'listResponseCodeShouldBe200OK'
+  xgen-IPA-105-list-method-no-request-body:
+    description: 'The List method request must not include a body. http://go/ipa/105'
+    message: '{{error}} http://go/ipa/105'
+    severity: warn
+    given: '$.paths[*].get'
+    then:
+      function: 'listMethodHasNoRequestBody'

tools/spectral/ipa/rulesets/README.md

@@ -42,9 +42,10 @@ For rule definitions, see [IPA-104.yaml](https://github.com/mongodb/openapi/blob
 
 For rule definitions, see [IPA-105.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/rulesets/IPA-105.yaml).
 
-| Rule Name                                     | Description                                                      | Severity |
-| --------------------------------------------- | ---------------------------------------------------------------- | -------- |
-| xgen-IPA-105-list-method-response-code-is-200 | The List method must return a 200 OK response. http://go/ipa/105 | warn     |
+| Rule Name                                     | Description                                                        | Severity |
+| --------------------------------------------- | ------------------------------------------------------------------ | -------- |
+| xgen-IPA-105-list-method-response-code-is-200 | The List method must return a 200 OK response. http://go/ipa/105   | warn     |
+| xgen-IPA-105-list-method-no-request-body      | The List method request must not include a body. http://go/ipa/105 | warn     |
 
 ### IPA-106
 

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

@@ -0,0 +1,41 @@
+import { hasException } from './utils/exceptions.js';
+import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import {
+  getResourcePathItems,
+  isResourceCollectionIdentifier,
+  isSingletonResource,
+} from './utils/resourceEvaluation.js';
+
+const RULE_NAME = 'xgen-IPA-105-list-method-no-request-body';
+const ERROR_MESSAGE = 'The List method must not include a request body.';
+
+export default (input, _, { path, documentInventory }) => {
+  const resourcePath = path[1];
+  const oas = documentInventory.resolved;
+
+  if (
+    !isResourceCollectionIdentifier(resourcePath) ||
+    (isResourceCollectionIdentifier(resourcePath) && isSingletonResource(getResourcePathItems(resourcePath, oas.paths)))
+  ) {
+    return;
+  }
+
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
+    return;
+  }
+
+  const errors = checkViolationsAndReturnErrors(input, path);
+
+  if (errors.length !== 0) {
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+  collectAdoption(path, RULE_NAME);
+};
+
+function checkViolationsAndReturnErrors(getOperationObject, path) {
+  if (getOperationObject.requestBody) {
+    return [{ path, message: ERROR_MESSAGE }];
+  }
+  return [];
+}