Committing changes to Fix Swagger descriptions to use "Reference to" … (

#7787)

* Committing changes to Fix Swagger descriptions to use "Reference to" instead of "Reference of"

* upgrade rest-api-specs-scripts version (#7712)

* bump avocado version to support $(this-folder) (#7743)

* regenerate package-lock.json (#7756)

* Committing changes with formatted descriptions

.azure-pipelines-preproduction/package.json

@@ -10,8 +10,8 @@
   "description": "Tests for Azure REST API Specifications",
   "license": "MIT",
   "devDependencies": {
-    "@azure/avocado": "^0.6.0",
-    "@azure/rest-api-specs-scripts": "^0.5.1",
+    "@azure/avocado": "^0.6.2",
+    "@azure/rest-api-specs-scripts": "^0.5.7",
     "@ts-common/commonmark-to-markdown": "^1.2.0",
     "@ts-common/fs": "0.2.0",
     "@ts-common/iterator": "^0.3.6",

package.json

@@ -12,7 +12,7 @@
   "devDependencies": {
     "@types/prettier": "^1.18.3",
     "@azure/avocado": "^0.6.0",
-    "@azure/rest-api-specs-scripts": "^0.4.0",
+    "@azure/rest-api-specs-scripts": "^0.5.7",
     "@ts-common/commonmark-to-markdown": "^1.2.0",
     "@ts-common/fs": "0.2.0",
     "@ts-common/iterator": "^0.3.6",

preproduction-azure-pipelines.yml

@@ -17,3 +17,4 @@ jobs:
 - template: .azure-pipelines/BreakingChange.yml
 - template: .azure-pipelines/ModelValidation.yml
 - template: .azure-pipelines/PrettierCheck.yml
+- template: .azure-pipelines/Avocado.yml

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/applicationGateway.json

@@ -886,11 +886,11 @@
         },
         "backendAddressPool": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of backend pool of application gateway to which probe request will be sent."
+          "description": "Reference to backend pool of application gateway to which probe request will be sent."
         },
         "backendHttpSettings": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of backend http setting of application gateway to be used for test probe."
+          "description": "Reference to backend http setting of application gateway to be used for test probe."
         }
       },
       "description": "Details of on demand test probe request."
@@ -899,7 +899,7 @@
       "properties": {
         "backendAddressPool": {
           "$ref": "#/definitions/ApplicationGatewayBackendAddressPool",
-          "description": "Reference of an ApplicationGatewayBackendAddressPool resource."
+          "description": "Reference to an ApplicationGatewayBackendAddressPool resource."
         },
         "backendHealthHttpSettings": {
           "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings",
@@ -924,7 +924,7 @@
       "properties": {
         "backendAddressPool": {
           "$ref": "#/definitions/ApplicationGatewayBackendAddressPool",
-          "description": "Reference of an ApplicationGatewayBackendAddressPool resource."
+          "description": "Reference to an ApplicationGatewayBackendAddressPool resource."
         },
         "backendHttpSettingsCollection": {
           "type": "array",
@@ -940,7 +940,7 @@
       "properties": {
         "backendHttpSettings": {
           "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings",
-          "description": "Reference of an ApplicationGatewayBackendHttpSettings resource."
+          "description": "Reference to an ApplicationGatewayBackendHttpSettings resource."
         },
         "servers": {
           "type": "array",
@@ -960,7 +960,7 @@
         },
         "ipConfiguration": {
           "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration",
-          "description": "Reference of IP configuration of backend server."
+          "description": "Reference to IP configuration of backend server."
         },
         "health": {
           "type": "string",
@@ -1069,7 +1069,7 @@
       "properties": {
         "subnet": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address."
+          "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address."
         },
         "provisioningState": {
           "readOnly": true,
@@ -1266,11 +1266,11 @@
         },
         "subnet": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the subnet resource."
+          "description": "Reference to the subnet resource."
         },
         "publicIPAddress": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the PublicIP resource."
+          "description": "Reference to the PublicIP resource."
         },
         "provisioningState": {
           "readOnly": true,
@@ -2184,7 +2184,7 @@
         },
         "firewallPolicy": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the FirewallPolicy resource."
+          "description": "Reference to the FirewallPolicy resource."
         },
         "enableHttp2": {
           "type": "boolean",

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/azureFirewall.json

@@ -374,11 +374,11 @@
         },
         "subnet": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'."
+          "description": "Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet'."
         },
         "publicIPAddress": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the PublicIP resource. This field is a mandatory input if subnet is not null."
+          "description": "Reference to the PublicIP resource. This field is a mandatory input if subnet is not null."
         },
         "provisioningState": {
           "readOnly": true,

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/bastionHost.json

@@ -297,11 +297,11 @@
       "properties": {
         "subnet": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the subnet resource."
+          "description": "Reference to the subnet resource."
         },
         "publicIPAddress": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "Reference of the PublicIP resource."
+          "description": "Reference to the PublicIP resource."
         },
         "provisioningState": {
           "readOnly": true,

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/expressRouteCircuit.json

@@ -1682,7 +1682,7 @@
           "items": {
             "type": "string"
           },
-          "description": "The reference of AdvertisedPublicPrefixes."
+          "description": "The reference to AdvertisedPublicPrefixes."
         },
         "advertisedCommunities": {
           "type": "array",
@@ -1739,7 +1739,7 @@
         },
         "routeFilter": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the RouteFilter resource."
+          "description": "The reference to the RouteFilter resource."
         },
         "state": {
           "type": "string",
@@ -1855,7 +1855,7 @@
         },
         "routeFilter": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the RouteFilter resource."
+          "description": "The reference to the RouteFilter resource."
         },
         "ipv6PeeringConfig": {
           "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig",

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/loadBalancer.json

@@ -1293,15 +1293,15 @@
         },
         "subnet": {
           "$ref": "./virtualNetwork.json#/definitions/Subnet",
-          "description": "The reference of the subnet resource."
+          "description": "The reference to the subnet resource."
         },
         "publicIPAddress": {
           "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress",
-          "description": "The reference of the Public IP resource."
+          "description": "The reference to the Public IP resource."
         },
         "publicIPPrefix": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the Public IP Prefix resource."
+          "description": "The reference to the Public IP Prefix resource."
         },
         "provisioningState": {
           "readOnly": true,
@@ -1427,7 +1427,7 @@
         },
         "probe": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the load balancer probe used by the load balancing rule."
+          "description": "The reference to the load balancer probe used by the load balancing rule."
         },
         "protocol": {
           "$ref": "#/definitions/TransportProtocol",

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/networkInterface.json

@@ -913,7 +913,7 @@
       "properties": {
         "virtualNetworkTap": {
           "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap",
-          "description": "The reference of the Virtual Network Tap resource."
+          "description": "The reference to the Virtual Network Tap resource."
         },
         "provisioningState": {
           "readOnly": true,
@@ -937,14 +937,14 @@
           "items": {
             "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayBackendAddressPool"
           },
-          "description": "The reference of ApplicationGatewayBackendAddressPool resource."
+          "description": "The reference to ApplicationGatewayBackendAddressPool resource."
         },
         "loadBalancerBackendAddressPools": {
           "type": "array",
           "items": {
             "$ref": "./loadBalancer.json#/definitions/BackendAddressPool"
           },
-          "description": "The reference of LoadBalancerBackendAddressPool resource."
+          "description": "The reference to LoadBalancerBackendAddressPool resource."
         },
         "loadBalancerInboundNatRules": {
           "type": "array",
@@ -1082,12 +1082,12 @@
       "properties": {
         "virtualMachine": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of a virtual machine.",
+          "description": "The reference to a virtual machine.",
           "readOnly": true
         },
         "networkSecurityGroup": {
           "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup",
-          "description": "The reference of the NetworkSecurityGroup resource."
+          "description": "The reference to the NetworkSecurityGroup resource."
         },
         "privateEndpoint": {
           "readOnly": true,
@@ -1480,11 +1480,11 @@
         },
         "subnet": {
           "$ref": "./virtualNetwork.json#/definitions/Subnet",
-          "description": "The reference of the subnet resource."
+          "description": "The reference to the subnet resource."
         },
         "publicIPAddress": {
           "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress",
-          "description": "The reference of the public IP resource."
+          "description": "The reference to the public IP resource."
         },
         "provisioningState": {
           "readOnly": true,

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/networkProfile.json

@@ -536,7 +536,7 @@
       "properties": {
         "subnet": {
           "$ref": "./virtualNetwork.json#/definitions/Subnet",
-          "description": "The reference of the subnet resource to create a container network interface ip configuration."
+          "description": "The reference to the subnet resource to create a container network interface ip configuration."
         },
         "provisioningState": {
           "readOnly": true,

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/networkWatcher.json

@@ -1588,11 +1588,11 @@
         },
         "targetVirtualNetwork": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the Virtual Network resource."
+          "description": "The reference to the Virtual Network resource."
         },
         "targetSubnet": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the Subnet resource."
+          "description": "The reference to the Subnet resource."
         }
       },
       "description": "Parameters that define the representation of topology."

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/virtualNetwork.json

@@ -1406,11 +1406,11 @@
         },
         "networkSecurityGroup": {
           "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup",
-          "description": "The reference of the NetworkSecurityGroup resource."
+          "description": "The reference to the NetworkSecurityGroup resource."
         },
         "routeTable": {
           "$ref": "./routeTable.json#/definitions/RouteTable",
-          "description": "The reference of the RouteTable resource."
+          "description": "The reference to the RouteTable resource."
         },
         "natGateway": {
           "$ref": "./network.json#/definitions/SubResource",
@@ -1539,11 +1539,11 @@
         },
         "remoteVirtualNetwork": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)."
+          "description": "The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)."
         },
         "remoteAddressSpace": {
           "$ref": "#/definitions/AddressSpace",
-          "description": "The reference of the remote virtual network address space."
+          "description": "The reference to the remote virtual network address space."
         },
         "peeringState": {
           "type": "string",

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/virtualNetworkGateway.json

@@ -2171,11 +2171,11 @@
         },
         "subnet": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the subnet resource."
+          "description": "The reference to the subnet resource."
         },
         "publicIPAddress": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the public IP resource."
+          "description": "The reference to the public IP resource."
         },
         "provisioningState": {
           "readOnly": true,
@@ -2265,23 +2265,23 @@
         },
         "gatewayDefaultSite": {
           "$ref": "./network.json#/definitions/SubResource",
-          "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting."
+          "description": "The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting."
         },
         "sku": {
           "$ref": "#/definitions/VirtualNetworkGatewaySku",
-          "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway."
+          "description": "The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway."
         },
         "vpnClientConfiguration": {
           "$ref": "#/definitions/VpnClientConfiguration",
-          "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations."
+          "description": "The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations."
         },
         "bgpSettings": {
           "$ref": "#/definitions/BgpSettings",
           "description": "Virtual network gateway's BGP speaker settings."
         },
         "customRoutes": {
           "$ref": "./virtualNetwork.json#/definitions/AddressSpace",
-          "description": "The reference of the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient."
+          "description": "The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient."
         },
         "resourceGuid": {
           "readOnly": true,
@@ -2391,7 +2391,7 @@
       "properties": {
         "vpnClientAddressPool": {
           "$ref": "./virtualNetwork.json#/definitions/AddressSpace",
-          "description": "The reference of the address space resource which represents Address space for P2S VpnClient."
+          "description": "The reference to the address space resource which represents Address space for P2S VpnClient."
         },
         "vpnClientRootCertificates": {
           "type": "array",

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/virtualNetworkTap.json

@@ -378,7 +378,7 @@
           "type": "array",
           "items": {
             "$ref": "./networkInterface.json#/definitions/NetworkInterfaceTapConfiguration",
-            "description": "The reference of the Network Interface."
+            "description": "The reference to the Network Interface."
           },
           "description": "Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped."
         },

specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/virtualWan.json

@@ -4400,7 +4400,7 @@
       "properties": {
         "vpnClientAddressPool": {
           "$ref": "./virtualNetwork.json#/definitions/AddressSpace",
-          "description": "The reference of the address space resource which represents Address space for P2S VpnClient."
+          "description": "The reference to the address space resource which represents Address space for P2S VpnClient."
         },
         "provisioningState": {
           "readOnly": true,