Added missing descriptions in Network specs (#5490)

* Added missing descriptions in Network specs * Add missing x-ms-enum
Azure · Mar 27, 2019 · 20aa68a · 20aa68a
1 parent 68cd0d3
commit 20aa68a
Show file tree

Hide file tree

Showing 16 changed files with 246 additions and 129 deletions.
diff --git a/...tion/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json b/...tion/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json
@@ -707,10 +707,11 @@
           "type": "array",
           "items": {
             "$ref": "#/definitions/ApplicationGatewayBackendHealthPool"
-          }
+          },
+          "description": "A list of ApplicationGatewayBackendHealthPool resources."
         }
       },
-      "description": "List of ApplicationGatewayBackendHealthPool resources."
+      "description": "Response for ApplicationGatewayBackendHealth API service call."
     },
     "ApplicationGatewayBackendHealthPool": {
       "properties": {
@@ -878,7 +879,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat",
+          "description": "Properties of the application gateway IP configuration."
         },
         "name": {
           "type": "string",
@@ -917,7 +919,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat",
+          "description": "Properties of the application gateway authentication certificate."
         },
         "name": {
           "type": "string",
@@ -960,7 +963,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat",
+          "description": "Properties of the application gateway trusted root certificate."
         },
         "name": {
           "type": "string",
@@ -1011,7 +1015,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat",
+          "description": "Properties of the application gateway SSL certificate."
         },
         "name": {
           "type": "string",
@@ -1070,7 +1075,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat",
+          "description": "Properties of the application gateway frontend IP configuration."
         },
         "name": {
           "type": "string",
@@ -1110,7 +1116,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat",
+          "description": "Properties of the application gateway frontend port."
         },
         "name": {
           "type": "string",
@@ -1172,7 +1179,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat",
+          "description": "Properties of the application gateway backend address pool."
         },
         "name": {
           "type": "string",
@@ -1283,7 +1291,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat",
+          "description": "Properties of the application gateway backend HTTP settings."
         },
         "name": {
           "type": "string",
@@ -1357,7 +1366,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat",
+          "description": "Properties of the application gateway HTTP listener."
         },
         "name": {
           "type": "string",
@@ -1415,7 +1425,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat",
+          "description": "Properties of the application gateway path rule."
         },
         "name": {
           "type": "string",
@@ -1514,7 +1525,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat",
+          "description": "Properties of the application gateway probe."
         },
         "name": {
           "type": "string",
@@ -1585,7 +1597,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat",
+          "description": "Properties of the application gateway request routing rule."
         },
         "name": {
           "type": "string",
@@ -1611,7 +1624,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat",
+          "description": "Properties of the application gateway rewrite rule set."
         },
         "name": {
           "type": "string",
@@ -1780,7 +1794,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat",
+          "description": "Properties of the application gateway redirect configuration."
         },
         "name": {
           "type": "string",
@@ -1967,7 +1982,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayPropertiesFormat",
+          "description": "Properties of the application gateway."
         },
         "etag": {
           "type": "string",
@@ -2044,7 +2060,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat",
+          "description": "Properties of the application gateway URL path map."
         },
         "name": {
           "type": "string",
@@ -2270,7 +2287,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat",
+          "description": "Properties of the application gateway firewall rule set."
         }
       },
       "allOf": [
@@ -2354,7 +2372,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat",
+          "description": "Properties of the application gateway available SSL options."
         }
       },
       "allOf": [
@@ -2418,7 +2437,8 @@
         },
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat"
+          "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat",
+          "description": "Properties of the application gateway SSDL predefined policy."
         }
       },
       "allOf": [
@@ -2528,6 +2548,7 @@
     },
     "RedirectTypeEnum": {
       "type": "string",
+      "description": "Redirect type enum.",
       "enum": [
         "Permanent",
         "Found",

diff --git a/...ification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewall.json b/...ification/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewall.json
@@ -281,9 +281,10 @@
       },
       "AzureFirewallIPConfiguration":{
          "properties":{
-            "properties":{
-               "x-ms-client-flatten":true,
-               "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat"
+            "properties": {
+               "x-ms-client-flatten": true,
+               "$ref": "#/definitions/AzureFirewallIPConfigurationPropertiesFormat",
+               "description": "Properties of the azure firewall IP configuration."
             },
             "name":{
                "type":"string",
@@ -345,9 +346,10 @@
       },
       "AzureFirewall":{
          "properties":{
-            "properties":{
-               "x-ms-client-flatten":true,
-               "$ref":"#/definitions/AzureFirewallPropertiesFormat"
+            "properties": {
+               "x-ms-client-flatten": true,
+               "$ref": "#/definitions/AzureFirewallPropertiesFormat",
+               "description": "Properties of the azure firewall."
             },
             "etag":{
                "type":"string",
@@ -422,9 +424,10 @@
       },
       "AzureFirewallApplicationRuleCollection":{
          "properties":{
-            "properties":{
-               "x-ms-client-flatten":true,
-               "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat"
+            "properties": {
+               "x-ms-client-flatten": true,
+               "$ref": "#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat",
+               "description": "Properties of the azure firewall application rule collection."
             },
             "name":{
                "type":"string",
@@ -533,9 +536,10 @@
       },
       "AzureFirewallNatRuleCollection":{
          "properties":{
-            "properties":{
-               "x-ms-client-flatten":true,
-               "$ref":"#/definitions/AzureFirewallNatRuleCollectionProperties"
+            "properties": {
+               "x-ms-client-flatten": true,
+               "$ref": "#/definitions/AzureFirewallNatRuleCollectionProperties",
+               "description": "Properties of the azure firewall NAT rule collection."
             },
             "name":{
                "type":"string",
@@ -655,9 +659,10 @@
       },
       "AzureFirewallNetworkRuleCollection":{
          "properties":{
-            "properties":{
-               "x-ms-client-flatten":true,
-               "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat"
+            "properties": {
+               "x-ms-client-flatten": true,
+               "$ref": "#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat",
+               "description": "Properties of the azure firewall network rule collection."
             },
             "name":{
                "type":"string",

diff --git a/...on/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json b/...on/network/resource-manager/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json
@@ -88,7 +88,8 @@
          "properties": {
             "properties": {
                "x-ms-client-flatten": true,
-               "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat"
+               "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat",
+               "description": "Properties of the azure firewall FQDN tag."
             },
             "etag": {
                "type": "string",

diff --git a/...ion/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json b/...ion/network/resource-manager/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json
@@ -1389,13 +1389,15 @@
           "type": "string",
           "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'."
         }
-      }
+      },
+      "description": "Properties of ExpressRouteCircuitAuthorization."
     },
     "ExpressRouteCircuitAuthorization": {
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/AuthorizationPropertiesFormat"
+          "$ref": "#/definitions/AuthorizationPropertiesFormat",
+          "description": "Properties of the express route circuit authorization."
         },
         "name": {
           "type": "string",
@@ -1629,13 +1631,15 @@
           "readOnly": true,
           "description": "The list of peered circuit connections associated with Azure Private Peering for this circuit."
         }
-      }
+      },
+      "description": "Properties of the express route circuit peering."
     },
     "ExpressRouteCircuitPeering": {
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat"
+          "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat",
+          "description": "Properties of the express route circuit peering."
         },
         "name": {
           "type": "string",
@@ -1732,13 +1736,15 @@
           "readOnly": true,
           "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'."
         }
-      }
+      },
+      "description": "Properties of the express route circuit connection."
     },
     "ExpressRouteCircuitConnection": {
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat"
+          "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat",
+          "description": "Properties of the express route circuit connection."
         },
         "name": {
           "type": "string",
@@ -1814,13 +1820,15 @@
           "readOnly": true,
           "description": "Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'."
         }
-      }
+      },
+      "description": "Properties of the peer express route circuit connection."
     },
     "PeerExpressRouteCircuitConnection": {
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat"
+          "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat",
+          "description": "Properties of the peer express route circuit connection."
         },
         "name": {
           "type": "string",
@@ -1999,7 +2007,8 @@
         },
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat"
+          "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat",
+          "description": "Properties of the express route circuit."
         },
         "etag": {
           "readOnly": true,
@@ -2194,7 +2203,8 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat"
+          "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat",
+          "description": "Properties of the express route service provider."
         }
       },
       "allOf": [