Add QueryParametersInCollectionGet linter rule (#745)

* Add QueryParametersInCollectionGet linter rule * Update logic to figure out list op paths * Add staging only * Address comments --------- Co-authored-by: akhilailla <[email protected]>
Azure · Sep 18, 2024 · a954384 · a954384
1 parent a19b89c
commit a954384
Show file tree

Hide file tree

Showing 9 changed files with 725 additions and 148 deletions.
diff --git a/docs/query-parameters-in-collection-get.md b/docs/query-parameters-in-collection-get.md
@@ -0,0 +1,78 @@
+# QueryParametersInCollectionGet
+
+## Category
+
+ARM Error
+
+## Applies to
+
+ARM OpenAPI(swagger) specs
+
+## Related ARM Guideline Code
+
+- RPC-Get-V1-15
+
+## Description
+
+Collection Get's/List operations MUST not have query parameters other than api-version & OData filter.
+
+## How to fix the violation
+
+Ensure that collection GET/List operations do not include any query parameters other than api-version and the OData $filter.
+
+## Good Examples
+
+```json
+      "Microsoft.Music/Songs": {
+        "get": {
+          "operationId": "Foo_Update",
+          "description": "Test Description",
+          "parameters": [
+            {
+              "name": "api-version",
+              "in": "query"
+            },
+          ],
+        },
+      },
+```
+
+```json
+      "Microsoft.Music/Songs": {
+        "get": {
+          "operationId": "Foo_Update",
+          "description": "Test Description",
+          "parameters": [
+            {
+              "name": "api-version",
+              "in": "query"
+            },
+            {
+              "name": "$filter",
+              "in": "query",
+              "required": false,
+              "type": "string",
+            },
+          ],
+        },
+      },
+```
+
+## Bad Examples
+
+```json
+      "Microsoft.Music/Songs": {
+        "get": {
+          "operationId": "Foo_Update",
+          "description": "Test Description",
+          "parameters": [
+            {
+              "name": "name",
+              "in": "query",
+              "required": false,
+              "type": "string",
+            },
+          ],
+        },
+      },
+```
diff --git a/docs/rules.md b/docs/rules.md
@@ -1040,6 +1040,12 @@ Synchronous and long-running PUT operations must have responses with 200, 201 an
 
 Please refer to [put-response-codes.md](./put-response-codes.md) for details.
 
+### QueryParametersInCollectionGet
+
+Collection Get's/List operations MUST not have query parameters other than api-version & OData filter.
+
+Please refer to [query-parameters-in-collection-get.md](./query-parameters-in-collection-get.md) for details.
+
 ### RepeatedPathInfo
 
 Information in the URI must not be repeated in the request body (i.e. subscription ID, resource group name, resource name).