merging the relevant checks from DeleteOperationAsyncResponseValidation into delete-response-codes and removing DeleteOperationAsyncResponseValidation (Azure#535)

* merging the relevant checks from DeleteOperationAsyncResponseValidation into delete-response-codes and removing DeleteOperationAsyncResponseValidation. Removing the status code checks from long-running-response-status-code

Author: rkmanda

common/changes/@microsoft.azure/openapi-validator-rulesets/rkmanda-DeleteOperationAsyncResponseValidation_2023-06-03-03-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft.azure/openapi-validator-rulesets",
+      "comment": "merging linter rules DeleteOperationAsyncResponseValidation and delete-response-codes and removing the checks from long-running-response-status-code as they have conflicting implementations",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft.azure/openapi-validator-rulesets"
+}

docs/delete-operation-async-response-validation.md

@@ -6,19 +6,14 @@ SDK Error
 
 ## Applies to
 
-ARM and Data plane OpenAPI(swagger) specs
-
-## Related ARM Guideline Code
-
-- RPC-Async-V1-01
+Data plane OpenAPI(swagger) specs
 
 ## Output Message
 
 A '{0}' operation '{1}' with x-ms-long-running-operation extension must have a valid terminal success status code {2}.
 
 ## Description
 
-For ARM spec, the allowed response status codes for a long DELETE operation are "200" & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200" & "201".
 For Data plane spec, the allowed response status codes for a long DELETE operation are "200","202", & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200","201", & "202".
 
 ## Why the rule is important

docs/long-running-response-status-code-data-plane.md

@@ -220,12 +220,6 @@ The request body of a delete operation must be empty.
 
 Please refer to [delete-must-not-have-request-body.md](./delete-must-not-have-request-body.md) for details.
 
-### DeleteOperationAsyncResponseValidation
-
-An async DELETE operation response include status code 202 with 'Location' header. Must support status code 200 if operation can be completed synchronously. Must support 204 (resource doesn't exists). Operation must also add "x-ms-long-running-operation and x-ms-long-running-operation-options" to mark that it is a long running operation (in case of 202) and how it is tracked (Location header).
-
-Please refer to [delete-operation-async-response-validation.md](./delete-operation-async-response-validation.md) for details.
-
 ### DeleteOperationResponses
 
 Per ARM Specs, all DELETE methods (non-async) must have responses code implementation: 200, 204.
@@ -450,18 +444,10 @@ Please refer to [long-running-operations-with-long-running-extension.md](./long-
 
 ### LongRunningResponseStatusCode
 
-For ARM spec, the allowed response status codes for a long DELETE operation are "200" & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200" & "201".
 For Data plane spec, the allowed response status codes for a long DELETE operation are "200","202", & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200","201", & "202".
 
 Please refer to [long-running-response-status-code-data-plane.md](./long-running-response-status-code-data-plane.md) for details.
 
-### LongRunningResponseStatusCode
-
-For ARM spec, the allowed response status codes for a long DELETE operation are "200" & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200" & "201".
-For Data plane spec, the allowed response status codes for a long DELETE operation are "200","202", & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200","201", & "202".
-
-Please refer to [long-running-response-status-code.md](./long-running-response-status-code.md) for details.
-
 ### LroErrorContent
 
 Error response content of long running operations must follow the error schema provided in the common types v2 and above.

docs/long-running-response-status-code.md

@@ -1464,20 +1464,35 @@ const consistentPatchProperties = (patchOp, _opts, ctx) => {
 
 const SYNC_DELETE_RESPONSES = ["200", "204", "default"];
 const LR_DELETE_RESPONSES = ["202", "204", "default"];
-const SYNC_ERROR = "Synchronous delete operations must have responses with 200, 204, and default return codes. They also must have no other response codes.";
-const LR_ERROR = "Long-running (LRO) delete operations must have responses with 202, 204, and default return codes. They also must have no other response codes.";
+const SYNC_ERROR = "Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes.";
+const LR_ERROR = "Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.";
+const EmptyResponse_ERROR = "Delete operation response codes must be non-empty. It must have response codes 200, 204 and default if it is sync or 202, 204 and default if it is long running.";
 const DeleteResponseCodes = (deleteOp, _opts, ctx) => {
     var _a;
     if (deleteOp === null || typeof deleteOp !== "object") {
         return [];
     }
     const path = ctx.path;
     const errors = [];
-    if (!(deleteOp === null || deleteOp === void 0 ? void 0 : deleteOp.responses)) {
-        return [];
-    }
     const responses = Object.keys((_a = deleteOp === null || deleteOp === void 0 ? void 0 : deleteOp.responses) !== null && _a !== void 0 ? _a : {});
-    if (deleteOp["x-ms-long-running-operation"] === true) {
+    if (responses.length == 0) {
+        errors.push({
+            message: EmptyResponse_ERROR,
+            path: path,
+        });
+        return errors;
+    }
+    const isAsyncOperation = deleteOp.responses["202"] ||
+        (deleteOp["x-ms-long-running-operation"] && deleteOp["x-ms-long-running-operation"] === true) ||
+        deleteOp["x-ms-long-running-operation-options"];
+    if (isAsyncOperation) {
+        if (!deleteOp["x-ms-long-running-operation"]) {
+            errors.push({
+                message: "An async DELETE operation must set '\"x-ms-long-running-operation\" : true'.",
+                path: path,
+            });
+            return errors;
+        }
         if (responses.length !== LR_DELETE_RESPONSES.length || !LR_DELETE_RESPONSES.every((value) => responses.includes(value))) {
             errors.push({
                 message: LR_ERROR,
@@ -1496,45 +1511,6 @@ const DeleteResponseCodes = (deleteOp, _opts, ctx) => {
     return errors;
 };
 
-const longRunningResponseStatusCode = (methodOp, _opts, ctx, validResponseCodesList) => {
-    var _a, _b, _c, _d;
-    if (methodOp === null || typeof methodOp !== "object") {
-        return [];
-    }
-    const path = ctx.path || [];
-    const errors = [];
-    const method = Object.keys(methodOp)[0];
-    if (!["delete", "put", "patch", "post"].includes(method)) {
-        return [];
-    }
-    const operationId = ((_a = methodOp === null || methodOp === void 0 ? void 0 : methodOp[method]) === null || _a === void 0 ? void 0 : _a.operationId) || "";
-    if (!((_b = methodOp === null || methodOp === void 0 ? void 0 : methodOp[method]) === null || _b === void 0 ? void 0 : _b["x-ms-long-running-operation"])) {
-        return [];
-    }
-    if ((_c = methodOp === null || methodOp === void 0 ? void 0 : methodOp[method]) === null || _c === void 0 ? void 0 : _c.responses) {
-        const responseCodes = Object.keys((_d = methodOp === null || methodOp === void 0 ? void 0 : methodOp[method]) === null || _d === void 0 ? void 0 : _d.responses);
-        const validResponseCodes = validResponseCodesList[method];
-        const validResponseCodeString = validResponseCodes.join(" or ");
-        const withTerminalCode = validResponseCodes.some((code) => responseCodes.includes(code));
-        if (!withTerminalCode) {
-            errors.push({
-                message: `A '${method}' operation '${operationId}' with x-ms-long-running-operation extension must have a valid terminal success status code ${validResponseCodeString}.`,
-                path: [...path, method],
-            });
-        }
-    }
-    return errors;
-};
-const longRunningResponseStatusCodeArm = (methodOp, _opts, ctx) => {
-    const validResponseCodesList = {
-        delete: ["200", "204"],
-        post: ["200", "201", "202", "204"],
-        put: ["200", "201"],
-        patch: ["200", "201", "202"],
-    };
-    return longRunningResponseStatusCode(methodOp, _opts, ctx, validResponseCodesList);
-};
-
 const getCollectionOnlyHasValueAndNextLink = (properties, _opts, ctx) => {
     if (!properties || typeof properties !== "object") {
         return [];
@@ -2598,17 +2574,6 @@ const ruleset = {
                 },
             },
         },
-        LongRunningResponseStatusCode: {
-            description: 'A LRO Post operation with return schema must have "x-ms-long-running-operation-options" extension enabled.',
-            message: "{{error}}",
-            severity: "error",
-            resolved: true,
-            formats: [oas2],
-            given: ["$[paths,'x-ms-paths'].*.*[?(@property === 'x-ms-long-running-operation' && @ === true)]^^"],
-            then: {
-                function: longRunningResponseStatusCodeArm,
-            },
-        },
         ProvisioningStateSpecifiedForLROPut: {
             description: 'A LRO PUT operation\'s response schema must have "ProvisioningState" property specified for the 200 and 201 status codes.',
             message: "{{error}}",

docs/rules.md

@@ -28,7 +28,6 @@ require("../legacyRules/NestedResourcesMustHaveListOperation")
 require("../legacyRules/TopLevelResourcesListByResourceGroup")
 require("../legacyRules/TopLevelResourcesListBySubscription")
 require("../legacyRules/CreateOperationAsyncResponseValidation")
-require("../legacyRules/DeleteOperationAsyncResponseValidation")
 require("../legacyRules/PostOperationAsyncResponseValidation")
 require("../legacyRules/Rpaas_ResourceProvisioningState")
 require("../legacyRules/PreviewVersionOverOneYear")