Update recommendation short descriptions for problem and solution. (#20624)

patrinid · patrinid · web-flow · commit 2a07629a9919 · 2022-09-14T08:33:20.000+08:00
* Update recommendation short descriptions for problem and solution.

* Fix verbiage on the new short description.

* Update sample uuid for empty response.

* Add example for List Operations.

* Run prettier on ListOperations example.

Co-authored-by: patrinid &lt;patrinid@microsoft.com&gt;
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/advisor.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/advisor.json
@@ -495,6 +495,11 @@
         "deprecated": false,
         "x-ms-pageable": {
           "nextLinkName": "nextLink"
+        },
+        "x-ms-examples": {
+          "ListRecommendations": {
+            "$ref": "./examples/ListOperations.json"
+          }
         }
       }
     },
@@ -1212,11 +1217,11 @@
       "type": "object",
       "properties": {
         "problem": {
-          "description": "The issue or opportunity identified by the recommendation.",
+          "description": "The issue or opportunity identified by the recommendation and proposed solution.",
           "type": "string"
         },
         "solution": {
-          "description": "The remediation action suggested by the recommendation.",
+          "description": "The issue or opportunity identified by the recommendation and proposed solution.",
           "type": "string"
         }
       }
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/EmptyResponse.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/EmptyResponse.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
-    "subscriptionId": "subscriptionId",
-    "operationId": "operationGUID",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "operationId": "00000000-0000-0000-0000-000000000000",
     "api-version": "2020-01-01"
   },
   "responses": {
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/GetRecommendationDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/GetRecommendationDetail.json
@@ -17,7 +17,7 @@
           "lastUpdated": "2017-02-24T22:24:43.3216408Z",
           "risk": "Warning",
           "shortDescription": {
-            "problem": "Monitoring agent is not installed on your machines",
+            "problem": "Monitoring agent should be installed on your machines",
             "solution": "Monitoring agent should be installed on your machines"
           },
           "remediation": {
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/ListOperations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/ListOperations.json
@@ -0,0 +1,32 @@
+{
+  "parameters": {
+    "api-version": "2020-01-01"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "name": "Microsoft.Advisor/advisorScore/read",
+            "display": {
+              "description": "Gets the score data for given subscription",
+              "operation": "Gets Advisor score",
+              "provider": "Microsoft Advisor",
+              "resource": "AdvisorScore"
+            }
+          },
+          {
+            "name": "Microsoft.Advisor/recommendations/read",
+            "display": {
+              "description": "Reads recommendations",
+              "operation": "Read recommendations",
+              "provider": "Microsoft Advisor",
+              "resource": "Recommendations"
+            }
+          }
+        ],
+        "nextLink": "string"
+      }
+    }
+  }
+}
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/ListRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/examples/ListRecommendations.json
@@ -25,7 +25,7 @@
                 "details": "link to document"
               },
               "shortDescription": {
-                "problem": "This availability set is not configured for fault tolerance",
+                "problem": "To ensure high availability add one or more virtual machines to this availability set",
                 "solution": "To ensure high availability add one or more virtual machines to this availability set"
               },
               "resourceMetadata": {
@@ -72,7 +72,7 @@
               "risk": "Warning",
               "shortDescription": {
                 "problem": "Monitoring agent is not installed on your machines",
-                "solution": "Monitoring agent should be installed on your machines"
+                "solution": "Monitoring agent is not installed on your machines"
               },
               "resourceMetadata": {
                 "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz",
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2022-09-01/advisor.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2022-09-01/advisor.json
@@ -1279,11 +1279,11 @@
       "type": "object",
       "properties": {
         "problem": {
-          "description": "The issue or opportunity identified by the recommendation.",
+          "description": "The issue or opportunity identified by the recommendation and proposed solution.",
           "type": "string"
         },
         "solution": {
-          "description": "The remediation action suggested by the recommendation.",
+          "description": "The issue or opportunity identified by the recommendation and proposed solution.",
           "type": "string"
         }
       }
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2022-09-01/examples/GetRecommendationDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2022-09-01/examples/GetRecommendationDetail.json
@@ -17,7 +17,7 @@
           "lastUpdated": "2017-02-24T22:24:43.3216408Z",
           "risk": "Warning",
           "shortDescription": {
-            "problem": "Monitoring agent is not installed on your machines",
+            "problem": "Monitoring agent should be installed on your machines",
             "solution": "Monitoring agent should be installed on your machines"
           },
           "remediation": {
diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2022-09-01/examples/ListRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2022-09-01/examples/ListRecommendations.json
@@ -25,7 +25,7 @@
                 "details": "link to document"
               },
               "shortDescription": {
-                "problem": "This availability set is not configured for fault tolerance",
+                "problem": "To ensure high availability add one or more virtual machines to this availability set",
                 "solution": "To ensure high availability add one or more virtual machines to this availability set"
               },
               "resourceMetadata": {
@@ -71,7 +71,7 @@
               "lastUpdated": "2017-02-24T22:24:43.3216408Z",
               "risk": "Warning",
               "shortDescription": {
-                "problem": "Monitoring agent is not installed on your machines",
+                "problem": "Monitoring agent should be installed on your machines",
                 "solution": "Monitoring agent should be installed on your machines"
               },
               "resourceMetadata": {

Original file line number	Diff line number	Diff line change
`@@ -1279,11 +1279,11 @@`
`1279`	`1279`	`"type": "object",`
`1280`	`1280`	`"properties": {`
`1281`	`1281`	`"problem": {`
`1282`		`- "description": "The issue or opportunity identified by the recommendation.",`
	`1282`	`+ "description": "The issue or opportunity identified by the recommendation and proposed solution.",`
`1283`	`1283`	`"type": "string"`
`1284`	`1284`	`},`
`1285`	`1285`	`"solution": {`
`1286`		`- "description": "The remediation action suggested by the recommendation.",`
	`1286`	`+ "description": "The issue or opportunity identified by the recommendation and proposed solution.",`
`1287`	`1287`	`"type": "string"`
`1288`	`1288`	`}`
`1289`	`1289`	`}`