Fix a couple issues with existing swaggers (#19735)

* Change to lowercase for the TestNotificationDetailsResponse contract * Revert "Change to lowercase for the TestNotificationDetailsResponse contract" This reverts commit 5d12256. * Task 14946056: Fix the Swagger, need to return response schema for POST API even API does not have a response * Need to fix examples * Pretty check * State to state Co-authored-by: Thomas Pham <thompham@microsoft.com>
Azure · Jul 19, 2022 · 5646dda · 5646dda
1 parent 778b162
commit 5646dda
Show file tree

Hide file tree

Showing 13 changed files with 803 additions and 201 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/...ation/monitor/resource-manager/Microsoft.Insights/stable/2022-04-01/actionGroups_API.json b/...ation/monitor/resource-manager/Microsoft.Insights/stable/2022-04-01/actionGroups_API.json
@@ -242,14 +242,20 @@
         ],
         "responses": {
           "202": {
-            "description": "The notification succeeded",
+            "description": "The notification request accepted",
             "headers": {
               "location": {
                 "type": "string",
                 "description": "The location header that has the polling uri."
               }
             }
           },
+          "200": {
+            "description": "The notification succeeded",
+            "schema": {
+              "$ref": "#/definitions/TestNotificationDetailsResponse"
+            }
+          },
           "default": {
             "description": "An error occurred while sending the test notifications",
             "schema": {
@@ -294,14 +300,20 @@
         ],
         "responses": {
           "202": {
-            "description": "The notification succeeded",
+            "description": "The notification request accepted",
             "headers": {
               "location": {
                 "type": "string",
                 "description": "The location header that has the polling uri."
               }
             }
           },
+          "200": {
+            "description": "The notification succeeded",
+            "schema": {
+              "$ref": "#/definitions/TestNotificationDetailsResponse"
+            }
+          },
           "default": {
             "description": "An error occurred while sending the test notifications",
             "schema": {
@@ -566,23 +578,23 @@
       "description": "The details of the test notification results.",
       "type": "object",
       "properties": {
-        "Context": {
+        "context": {
           "type": "object",
           "$ref": "#/definitions/Context"
         },
-        "State": {
+        "state": {
           "type": "string",
           "description": "The overall state"
         },
-        "CompletedTime": {
+        "completedTime": {
           "type": "string",
           "description": "The completed time"
         },
-        "CreatedTime": {
+        "createdTime": {
           "type": "string",
           "description": "The created time"
         },
-        "ActionDetails": {
+        "actionDetails": {
           "x-ms-identifiers": [],
           "type": "array",
           "items": {
@@ -592,7 +604,7 @@
         }
       },
       "required": [
-        "State"
+        "state"
       ]
     },
     "ActionDetail": {
@@ -629,11 +641,11 @@
       "description": "The context info",
       "type": "object",
       "properties": {
-        "NotificationSource": {
+        "notificationSource": {
           "type": "string",
           "description": "The source of the notification request"
         },
-        "ContextType": {
+        "contextType": {
           "type": "string",
           "description": "The context id type"
         }

diff --git a/.../resource-manager/Microsoft.Insights/stable/2022-04-01/examples/getTestNotifications.json b/.../resource-manager/Microsoft.Insights/stable/2022-04-01/examples/getTestNotifications.json
@@ -8,14 +8,14 @@
     "200": {
       "headers": {},
       "body": {
-        "Context": {
-          "NotificationSource": "Microsoft.Insights/TestNotification",
-          "ContextType": "Microsoft.Insights/Budget"
+        "context": {
+          "notificationSource": "Microsoft.Insights/TestNotification",
+          "contextType": "Microsoft.Insights/Budget"
         },
-        "State": "Completed",
-        "CompletedTime": "0001-01-01T00:00:00+00:00",
-        "CreatedTime": "2021-09-21T04:52:29.5091168+00:00",
-        "ActionDetails": [
+        "state": "Completed",
+        "completedTime": "0001-01-01T00:00:00+00:00",
+        "createdTime": "2021-09-21T04:52:29.5091168+00:00",
+        "actionDetails": [
           {
             "MechanismType": "AzureAppPush",
             "Name": "AzureAppPush-name",

diff --git a/...crosoft.Insights/stable/2022-04-01/examples/getTestNotificationsAtResourceGroupLevel.json b/...crosoft.Insights/stable/2022-04-01/examples/getTestNotificationsAtResourceGroupLevel.json
@@ -9,14 +9,14 @@
     "200": {
       "headers": {},
       "body": {
-        "Context": {
-          "NotificationSource": "Microsoft.Insights/TestNotification",
-          "ContextType": "Microsoft.Insights/Budget"
+        "context": {
+          "notificationSource": "Microsoft.Insights/TestNotification",
+          "contextType": "Microsoft.Insights/Budget"
         },
-        "State": "Completed",
-        "CompletedTime": "0001-01-01T00:00:00+00:00",
-        "CreatedTime": "2021-09-21T04:52:29.5091168+00:00",
-        "ActionDetails": [
+        "state": "Completed",
+        "completedTime": "0001-01-01T00:00:00+00:00",
+        "createdTime": "2021-09-21T04:52:29.5091168+00:00",
+        "actionDetails": [
           {
             "MechanismType": "AzureAppPush",
             "Name": "AzureAppPush-name",

diff --git a/...resource-manager/Microsoft.Insights/stable/2022-04-01/examples/postTestNotifications.json b/...resource-manager/Microsoft.Insights/stable/2022-04-01/examples/postTestNotifications.json
@@ -120,7 +120,109 @@
   "responses": {
     "202": {
       "headers": {
-        "location": "https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Test-Rg/providers/microsoft.insights/notificationStatus/11111111111111?api-version=2021-09-01"
+        "location": "https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/providers/microsoft.insights/notificationStatus/11111111111111?api-version=2022-04-01"
+      }
+    },
+    "200": {
+      "headers": {},
+      "body": {
+        "context": {
+          "notificationSource": "Microsoft.Insights/TestNotification",
+          "contextType": "Microsoft.Insights/Budget"
+        },
+        "state": "Completed",
+        "completedTime": "0001-01-01T00:00:00+00:00",
+        "createdTime": "2021-09-21T04:52:29.5091168+00:00",
+        "actionDetails": [
+          {
+            "MechanismType": "AzureAppPush",
+            "Name": "AzureAppPush-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.8620629+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "AzureFunction",
+            "Name": "AzureFunction-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0623319+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Email",
+            "Name": "Email-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:40.7480368+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "LogicApp",
+            "Name": "LogicApp-Name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.2473419+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Webhook",
+            "Name": "Webhook-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "SecureWebhook",
+            "Name": "SecureWebhook-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Sms",
+            "Name": "Sms-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:41.353015+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Voice",
+            "Name": "Voice-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:41.6330734+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "EventHub",
+            "Name": "EventHub-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "AutomationRunbook",
+            "Name": "AutomationRunbook-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Itsm",
+            "Name": "Itsm-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          }
+        ]
       }
     }
   }

diff --git a/...rosoft.Insights/stable/2022-04-01/examples/postTestNotificationsAtResourceGroupLevel.json b/...rosoft.Insights/stable/2022-04-01/examples/postTestNotificationsAtResourceGroupLevel.json
@@ -121,7 +121,109 @@
   "responses": {
     "202": {
       "headers": {
-        "location": "https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Test-Rg/providers/microsoft.insights/notificationStatus/11111111111111?api-version=2021-09-01"
+        "location": "https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Test-Rg/providers/microsoft.insights/notificationStatus/11111111111111?api-version=2022-04-01"
+      }
+    },
+    "200": {
+      "headers": {},
+      "body": {
+        "context": {
+          "notificationSource": "Microsoft.Insights/TestNotification",
+          "contextType": "Microsoft.Insights/Budget"
+        },
+        "state": "Completed",
+        "completedTime": "0001-01-01T00:00:00+00:00",
+        "createdTime": "2021-09-21T04:52:29.5091168+00:00",
+        "actionDetails": [
+          {
+            "MechanismType": "AzureAppPush",
+            "Name": "AzureAppPush-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.8620629+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "AzureFunction",
+            "Name": "AzureFunction-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0623319+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Email",
+            "Name": "Email-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:40.7480368+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "LogicApp",
+            "Name": "LogicApp-Name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.2473419+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Webhook",
+            "Name": "Webhook-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "SecureWebhook",
+            "Name": "SecureWebhook-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Sms",
+            "Name": "Sms-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:41.353015+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Voice",
+            "Name": "Voice-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:41.6330734+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "EventHub",
+            "Name": "EventHub-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "AutomationRunbook",
+            "Name": "AutomationRunbook-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          },
+          {
+            "MechanismType": "Itsm",
+            "Name": "Itsm-name",
+            "Status": "Completed",
+            "SubState": "Default",
+            "SendTime": "2021-09-21T04:52:42.0723479+00:00",
+            "Detail": null
+          }
+        ]
       }
     }
   }