CLOUDP-271995: Adds rule for update method must not have query param

Author: lovisaberggren

tools/spectral/ipa/ipa-spectral.yaml

@@ -4,6 +4,7 @@ extends:
   - ./rulesets/IPA-104.yaml
   - ./rulesets/IPA-105.yaml
   - ./rulesets/IPA-106.yaml
+  - ./rulesets/IPA-107.yaml
   - ./rulesets/IPA-108.yaml
   - ./rulesets/IPA-109.yaml
   - ./rulesets/IPA-113.yaml

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

@@ -28,6 +28,7 @@ rules:
     given: '$.paths[*].post'
     then:
       function: 'createMethodShouldNotHaveQueryParameters'
+      ignoredValues: [ 'pretty', 'envelope' ]
   xgen-IPA-106-create-method-request-body-is-get-method-response:
     description: >-
       Request body content of the Create method and response content of the Get method should refer to the same resource. http://go/ipa/106

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

@@ -0,0 +1,27 @@
+# IPA-107: Update
+# http://go/ipa/107
+
+functions:
+  - updateMethodMustNotHaveQueryParams
+
+rules:
+  xgen-IPA-107-put-must-not-have-query-params:
+    description: >-
+      Update operations must not accept query parameters. http://go/ipa/107
+    message: '{{error}} http://go/ipa/107'
+    severity: warn
+    given: '$.paths[*].put'
+    then:
+      function: 'updateMethodMustNotHaveQueryParams'
+      functionOptions:
+        ignoredValues: [ 'pretty', 'envelope' ]
+  xgen-IPA-107-patch-must-not-have-query-params:
+    description: >-
+      Update operations must not accept query parameters. http://go/ipa/107
+    message: '{{error}} http://go/ipa/107'
+    severity: warn
+    given: '$.paths[*].patch'
+    then:
+      function: 'updateMethodMustNotHaveQueryParams'
+      functionOptions:
+        ignoredValues: [ 'pretty', 'envelope' ]

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

@@ -15,9 +15,14 @@ import {
 const RULE_NAME = 'xgen-IPA-106-create-method-should-not-have-query-parameters';
 const ERROR_MESSAGE = 'Create operations should not have query parameters.';
 
-const ignoredParameters = ['envelope', 'pretty'];
-
-export default (input, _, { path, documentInventory }) => {
+/**
+ * Create operations should not have query parameters.
+ *
+ * @param {object} input - The create operation object
+ * @param {{ignoredValues: string[]}} opts - Array of ignored query parameters
+ * @param {object} context - The context object containing the path and document
+ */
+export default (input, opts, { path, documentInventory }) => {
   const resourcePath = path[1];
   const oas = documentInventory.resolved;
   const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
@@ -37,21 +42,23 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  const errors = checkViolationsAndReturnErrors(postMethod.parameters, path);
+  const errors = checkViolationsAndReturnErrors(postMethod.parameters, path, opts);
   if (errors.length !== 0) {
     return collectAndReturnViolation(path, RULE_NAME, errors);
   }
   collectAdoption(path, RULE_NAME);
 };
 
-function checkViolationsAndReturnErrors(postMethodParameters, path) {
+function checkViolationsAndReturnErrors(postMethodParameters, path, opts) {
   const errors = [];
   try {
+    const ignoredValues = opts?.ignoredValues || [];
+
     for (const parameter of postMethodParameters) {
-      if (parameter.in === 'query' && !ignoredParameters.includes(parameter.name)) {
+      if (parameter.in === 'query' && !ignoredValues.includes(parameter.name)) {
         errors.push({
           path: path,
-          message: `Input parameter [${parameter.name}]: ${ERROR_MESSAGE}`,
+          message: `${ERROR_MESSAGE}. Found [${parameter.name}] `,
         });
       }
     }

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

@@ -0,0 +1,69 @@
+import { hasException } from './utils/exceptions.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+  handleInternalError,
+} from './utils/collectionUtils.js';
+import {
+  getResourcePathItems,
+  isResourceCollectionIdentifier,
+  isSingleResourceIdentifier,
+  isSingletonResource,
+} from './utils/resourceEvaluation.js';
+
+const ERROR_MESSAGE = 'Update operations must not have query parameters.';
+
+/**
+ * Update operations must not have query parameters.
+ *
+ * @param {object} input - The update operation object
+ * @param {{ignoredValues: string[]}} opts - Array of ignored query parameters
+ * @param {object} context - The context object containing the path, document and rule
+ */
+export default (input, opts, { path, documentInventory, rule }) => {
+  const resourcePath = path[1];
+  const oas = documentInventory.resolved;
+  const resourcePathItems = getResourcePathItems(resourcePath, oas.paths);
+
+  if (
+    !isSingleResourceIdentifier(resourcePath) ||
+    (isResourceCollectionIdentifier(resourcePath) && !isSingletonResource(resourcePathItems))
+  ) {
+    return;
+  }
+
+  if (!input.parameters || input.parameters.length === 0) {
+    return;
+  }
+
+  if (hasException(input, rule)) {
+    collectException(input, rule, path);
+    return;
+  }
+
+  const errors = checkViolationsAndReturnErrors(input.parameters, path, rule, opts);
+  if (errors.length !== 0) {
+    return collectAndReturnViolation(path, rule, errors);
+  }
+  collectAdoption(path, rule);
+};
+
+function checkViolationsAndReturnErrors(postMethodParameters, path, rule, opts) {
+  const errors = [];
+  try {
+    const ignoredValues = opts?.ignoredValues || [];
+
+    for (const parameter of postMethodParameters) {
+      if (parameter.in === 'query' && !ignoredValues.includes(parameter.name)) {
+        errors.push({
+          path: path,
+          message: `${ERROR_MESSAGE}. Found [${parameter.name}] `,
+        });
+      }
+    }
+    return errors;
+  } catch (e) {
+    handleInternalError(rule, path, e);
+  }
+}