Fix swagger correctness errors (#12246)

* Fix swagger correctness issues in Security for Iot service * changed int format from 32 to 64 * Add systemData to iotSecuritySolutions Co-authored-by: Liran Chen <lirche@microsoft.com>
Azure · Jan 4, 2021 · e5c779c · e5c779c
1 parent 494cf91
commit e5c779c
Show file tree

Hide file tree

Showing 18 changed files with 509 additions and 183 deletions.
diff --git a/...manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json b/...manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json
@@ -7,6 +7,9 @@
   "responses": {
     "200": {
       "body": {
+        "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+        "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+        "type": "Microsoft.Security/iotAlerts",
         "properties": {
           "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
           "compromisedEntity": "device-1",

diff --git a/...ger/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json b/...ger/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json
@@ -13,6 +13,9 @@
       "body": {
         "value": [
           {
+            "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+            "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+            "type": "Microsoft.Security/iotAlerts",
             "properties": {
               "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
               "compromisedEntity": "device-1",

diff --git a/...on/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json b/...on/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json
@@ -206,7 +206,12 @@
           "description": "Alert properties",
           "$ref": "#/definitions/IotAlertPropertiesModel"
         }
-      }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../common/v1/types.json#/definitions/Resource"
+        }
+      ]
     },
     "IotAlertPropertiesModel": {
       "type": "object",

diff --git a/.../security/resource-manager/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json b/.../security/resource-manager/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json
@@ -364,6 +364,16 @@
       ],
       "properties": {}
     },
+    "ConnectionFromIpNotAllowed": {
+      "type": "object",
+      "description": "Inbound connection from an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation.",
+      "allOf": [
+        {
+          "$ref": "#/definitions/AllowlistCustomAlertRule"
+        }
+      ],
+      "properties": {}
+    },
     "LocalUserNotAllowed": {
       "type": "object",
       "description": "Login by a local user that isn't allowed. Allow list consists of login names to allow.",
@@ -416,10 +426,12 @@
       "properties": {
         "minThreshold": {
           "type": "integer",
+          "format": "int32",
           "description": "The minimum threshold."
         },
         "maxThreshold": {
           "type": "integer",
+          "format": "int32",
           "description": "The maximum threshold."
         }
       },

diff --git a/...rity/stable/2019-08-01/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json b/...rity/stable/2019-08-01/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json
diff --git a/...t.Security/stable/2019-08-01/examples/IoTSecuritySolutions/CreateIoTSecuritySolution.json b/...t.Security/stable/2019-08-01/examples/IoTSecuritySolutions/CreateIoTSecuritySolution.json
@@ -146,6 +146,14 @@
             }
           ],
           "unmaskedIpLoggingStatus": "Enabled"
+        },
+        "systemData": {
+          "createdBy": "string",
+          "createdByType": "User",
+          "createdAt": "2020-04-27T21:53:29.0928001Z",
+          "lastModifiedBy": "string",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
         }
       }
     },
@@ -258,6 +266,14 @@
             }
           ],
           "unmaskedIpLoggingStatus": "Enabled"
+        },
+        "systemData": {
+          "createdBy": "string",
+          "createdByType": "User",
+          "createdAt": "2020-04-27T21:53:29.0928001Z",
+          "lastModifiedBy": "string",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
         }
       }
     }

diff --git a/...soft.Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolution.json b/...soft.Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolution.json
@@ -115,6 +115,14 @@
             }
           ],
           "unmaskedIpLoggingStatus": "Enabled"
+        },
+        "systemData": {
+          "createdBy": "string",
+          "createdByType": "User",
+          "createdAt": "2020-04-27T21:53:29.0928001Z",
+          "lastModifiedBy": "string",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
         }
       }
     }

diff --git a/...Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsList.json b/...Security/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsList.json
@@ -115,6 +115,14 @@
                 }
               ],
               "unmaskedIpLoggingStatus": "Enabled"
+            },
+            "systemData": {
+              "createdBy": "string",
+              "createdByType": "User",
+              "createdAt": "2020-04-27T21:53:29.0928001Z",
+              "lastModifiedBy": "string",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
             }
           },
           {
@@ -227,6 +235,14 @@
                 }
               ],
               "unmaskedIpLoggingStatus": "Enabled"
+            },
+            "systemData": {
+              "createdBy": "string",
+              "createdByType": "User",
+              "createdAt": "2020-04-27T21:53:29.0928001Z",
+              "lastModifiedBy": "string",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
             }
           }
         ]

diff --git a/.../stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByIotHub.json b/.../stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByIotHub.json
@@ -118,6 +118,14 @@
                 }
               ],
               "unmaskedIpLoggingStatus": "Enabled"
+            },
+            "systemData": {
+              "createdBy": "string",
+              "createdByType": "User",
+              "createdAt": "2020-04-27T21:53:29.0928001Z",
+              "lastModifiedBy": "string",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
             }
           }
         ]

diff --git a/...le/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByIotHubAndRg.json b/...le/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByIotHubAndRg.json
@@ -119,6 +119,14 @@
                 }
               ],
               "unmaskedIpLoggingStatus": "Enabled"
+            },
+            "systemData": {
+              "createdBy": "string",
+              "createdByType": "User",
+              "createdAt": "2020-04-27T21:53:29.0928001Z",
+              "lastModifiedBy": "string",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
             }
           }
         ]

diff --git a/...rity/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByRg.json b/...rity/stable/2019-08-01/examples/IoTSecuritySolutions/GetIoTSecuritySolutionsListByRg.json
@@ -116,6 +116,14 @@
                 }
               ],
               "unmaskedIpLoggingStatus": "Enabled"
+            },
+            "systemData": {
+              "createdBy": "string",
+              "createdByType": "User",
+              "createdAt": "2020-04-27T21:53:29.0928001Z",
+              "lastModifiedBy": "string",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
             }
           }
         ]

diff --git a/...t.Security/stable/2019-08-01/examples/IoTSecuritySolutions/UpdateIoTSecuritySolution.json b/...t.Security/stable/2019-08-01/examples/IoTSecuritySolutions/UpdateIoTSecuritySolution.json
@@ -142,6 +142,14 @@
             }
           ],
           "unmaskedIpLoggingStatus": "Enabled"
+        },
+        "systemData": {
+          "createdBy": "string",
+          "createdByType": "User",
+          "createdAt": "2020-04-27T21:53:29.0928001Z",
+          "lastModifiedBy": "string",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
         }
       }
     }

diff --git a/...resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlert.json b/...resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlert.json
@@ -9,6 +9,9 @@
   "responses": {
     "200": {
       "body": {
+        "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+        "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+        "type": "Microsoft.Security/iotAlerts",
         "properties": {
           "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
           "compromisedEntity": "device-1",

diff --git a/...urce-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json b/...urce-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json
@@ -15,6 +15,9 @@
       "body": {
         "value": [
           {
+            "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+            "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
+            "type": "Microsoft.Security/iotAlerts",
             "properties": {
               "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
               "compromisedEntity": "device-1",

diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json
@@ -209,7 +209,12 @@
           "description": "Alert properties",
           "$ref": "#/definitions/IotAlertProperties"
         }
-      }
+      },
+      "allOf": [
+        {
+          "$ref": "../../../common/v1/types.json#/definitions/Resource"
+        }
+      ]
     },
     "IotAlertProperties": {
       "type": "object",

diff --git a/...y/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json b/...y/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json
@@ -148,7 +148,8 @@
             "in": "query",
             "description": "Number of results to retrieve.",
             "required": false,
-            "type": "integer"
+            "type": "integer",
+            "format": "int32"
           }
         ],
         "responses": {
@@ -332,7 +333,8 @@
             "in": "query",
             "description": "Number of results to retrieve.",
             "required": false,
-            "type": "integer"
+            "type": "integer",
+            "format": "int32"
           }
         ],
         "responses": {
@@ -362,14 +364,17 @@
       "properties": {
         "high": {
           "type": "integer",
+          "format": "int64",
           "description": "Count of high severity alerts/recommendations."
         },
         "medium": {
           "type": "integer",
+          "format": "int64",
           "description": "Count of medium severity alerts/recommendations."
         },
         "low": {
           "type": "integer",
+          "format": "int64",
           "description": "Count of low severity alerts/recommendations."
         }
       }
@@ -401,6 +406,7 @@
         },
         "unhealthyDeviceCount": {
           "type": "integer",
+          "format": "int64",
           "readOnly": true,
           "description": "Number of unhealthy devices within your IoT Security solution."
         },
@@ -607,6 +613,7 @@
         "count": {
           "readOnly": true,
           "type": "integer",
+          "format": "int64",
           "description": "Number of alerts occurrences within the aggregated time window."
         },
         "effectedResourceType": {
@@ -643,6 +650,7 @@
               "alertsCount": {
                 "readOnly": true,
                 "type": "integer",
+                "format": "int64",
                 "description": "Number of alerts raised for this device."
               },
               "lastOccurrence": {
@@ -739,11 +747,13 @@
         "healthyDevices": {
           "readOnly": true,
           "type": "integer",
+          "format": "int64",
           "description": "Number of healthy devices within the IoT Security solution."
         },
         "unhealthyDeviceCount": {
           "readOnly": true,
           "type": "integer",
+          "format": "int64",
           "description": "Number of unhealthy devices within the IoT Security solution."
         },
         "logAnalyticsQuery": {
@@ -765,6 +775,7 @@
         "alertsCount": {
           "readOnly": true,
           "type": "integer",
+          "format": "int64",
           "description": "Number of alerts raised for this device."
         }
       }
@@ -810,6 +821,7 @@
         "alertsCount": {
           "readOnly": true,
           "type": "integer",
+          "format": "int64",
           "description": "Number of alerts raised for this alert type."
         }
       }
@@ -855,6 +867,7 @@
         "devicesCount": {
           "readOnly": true,
           "type": "integer",
+          "format": "int64",
           "description": "Number of devices with this recommendation."
         }
       }