Implement RPC-GET-V1-08 (Azure#482)

* with-xms-resource.test.ts

Implement RPC-Put-V1-24 (ResponseSchemaSpecifiedForSuccessStatusCode)

* minor updates

* Implement RPC-Async-V1-02

* update fixes

* resolve rules.md indexing issue

* fix CI lint errors

* fix failing test

* fix changelog error

* updates based on comments

* first pass

* add function

* implement RPC-GET-V1-08

* Add change log

* fix build failures

* updadtes based on comments

* Update packages/rulesets/src/spectral/functions/utils.ts

---------

Co-authored-by: akhilailla <[email protected]>
Co-authored-by: Brett DeFoy <[email protected]>

Author: 3 people

common/changes/@microsoft.azure/openapi-validator-rulesets/implement-RPC-Get-V1-08_2023-03-28-17-09.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft.azure/openapi-validator-rulesets",
+      "comment": "implement RPC-GET-V1-08",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft.azure/openapi-validator-rulesets"
+}

docs/parameters-in-point-get.md

@@ -0,0 +1,25 @@
+# ParametersInPointGet
+
+## Category
+
+ARM Error
+
+## Applies to
+
+ARM OpenAPI(swagger) specs
+
+## Related ARM Guideline Code
+
+- RPC-Get-V1-08
+
+## Output Message
+
+Query parameter {0} should be removed. Point gets MUST not have query parameters other than API version
+
+## Description
+
+Point Get's MUST not have query parameters other than api version.
+
+## How to fix the violation
+
+Ensure that no query parameters are present for point get operations, except for api-version.

docs/rules.md

@@ -342,6 +342,12 @@ The get operation should only return 200, also it should not be a long running o
 
 Please refer to [get-operation200.md](./get-operation200.md) for details.
 
+### ParametersInPointGet
+
+Point Get's MUST not have query parameters other than api version.
+
+Please refer to [parameters-in-point-get.md](./parameters-in-point-get.md) for details.
+
 ### GuidUsage
 
 Verifies whether format is specified as "uuid" or not.

packages/rulesets/src/spectral/az-arm.ts

@@ -22,6 +22,7 @@ import noDuplicatePathsForScopeParameter from "./functions/no-duplicate-paths-fo
 import operationsApiSchema from "./functions/operations-api-schema"
 import { parameterNotDefinedInGlobalParameters } from "./functions/parameter-not-defined-in-global-parameters"
 import { parameterNotUsingCommonTypes } from "./functions/parameter-not-using-common-types"
+import { ParametersInPointGet } from "./functions/parameters-in-point-get"
 import { ParametersInPost } from "./functions/parameters-in-post"
 import pathBodyParameters from "./functions/patch-body-parameters"
 import { PatchResponseCode } from "./functions/patch-response-code"
@@ -253,6 +254,19 @@ const ruleset: any = {
       },
     },
 
+    // RPC Code: RPC-Get-V1-08
+    ParametersInPointGet: {
+      description: "Point Get's MUST not have query parameters other than api version.",
+      severity: "error",
+      message: "{{error}}",
+      resolved: true,
+      formats: [oas2],
+      given: "$[paths,'x-ms-paths']",
+      then: {
+        function: ParametersInPointGet,
+      },
+    },
+
     ///
     /// ARM RPC rules for Patch patterns
     ///

packages/rulesets/src/spectral/functions/parameters-in-point-get.ts

@@ -0,0 +1,31 @@
+import { getResourcesPathHierarchyBasedOnResourceType } from "./utils"
+
+export const ParametersInPointGet = (pathItem: any, _opts: any, ctx: any) => {
+  if (pathItem === null || typeof pathItem !== "object") {
+    return []
+  }
+
+  const path = ctx.path || []
+  const uris = Object.keys(pathItem)
+  if (uris.length < 1) {
+    return []
+  }
+  const GET = "get"
+  const errors: any[] = []
+
+  for (const uri of uris) {
+    const hierarchy = getResourcesPathHierarchyBasedOnResourceType(uri)
+    if (hierarchy.length >= 1 && pathItem[uri][GET]) {
+      const params = pathItem[uri][GET]["parameters"]
+      const queryParams = params.filter((param: { in: string; name: string }) => param.in === "query" && param.name !== "api-version")
+      queryParams.map((param: { name: any }) => {
+        errors.push({
+          message: `Query parameter ${param.name} should be removed. Point Get's MUST not have query parameters other than api version.`,
+          path: [path, uri, GET, "parameters"],
+        })
+      })
+    }
+  }
+
+  return errors
+}

packages/rulesets/src/spectral/functions/utils.ts

@@ -152,25 +152,51 @@ export function isXmsResource(schema: any) {
 
 export function isSchemaEqual(a: any, b: any): boolean {
   if (a && b) {
-    const propsA = Object.getOwnPropertyNames(a);
-    const propsB = Object.getOwnPropertyNames(b);
+    const propsA = Object.getOwnPropertyNames(a)
+    const propsB = Object.getOwnPropertyNames(b)
     if (propsA.length === propsB.length) {
       for (let i = 0; i < propsA.length; i++) {
-        const propsAName = propsA[i];
-        const [propA, propB] = [a[propsAName], b[propsAName]];
+        const propsAName = propsA[i]
+        const [propA, propB] = [a[propsAName], b[propsAName]]
         if (typeof propA === "object") {
           if (!isSchemaEqual(propA, propB)) {
-            return false;
+            return false
           } else if (i === propsA.length - 1) {
-            return true;
+            return true
           }
         } else if (propA !== propB) {
-          return false;
+          return false
         } else if (propA === propB && i === propsA.length - 1) {
-          return true;
+          return true
         }
       }
     }
   }
-  return false;
+  return false
+}
+
+const providerAndNamespace = "/providers/[^/]+"
+const resourceTypeAndResourceName = "(?:/\\w+/default|/\\w+/{[^/]+})"
+const queryParam = "(?:\\?\\w+)"
+const resourcePathRegEx = new RegExp(`${providerAndNamespace}${resourceTypeAndResourceName}+${queryParam}?$`, "gi")
+export function getResourcesPathHierarchyBasedOnResourceType(path: string) {
+  const index = path.lastIndexOf("/providers/")
+  if (index === -1) {
+    return []
+  }
+  const lastProvider = path.substr(index)
+  const result = []
+  const matches = lastProvider.match(resourcePathRegEx)
+  if (matches && matches.length) {
+    const match = matches[0]
+    // slice the array to remove 'providers', provider namespace
+    const resourcePathSegments = match.split("/").slice(3)
+    for (const resourcePathSegment of resourcePathSegments) {
+      if (resourcePathSegment.startsWith("{") || resourcePathSegment === "default") {
+        continue
+      }
+      result.push(resourcePathSegment)
+    }
+  }
+  return result
 }