Resolving 2023-05-01 swagger validation errors for Azure Firewall exa…

…mples. (#27403) * Added missing id property to some example resources. Added headers with locations to long-running operation examples. * Added some missing information on some response object typings regarding the location property used in long-running operations. * Fixed a possible typo 'azure-async-operation' to 'azure-asyncoperation' (removed a hyphen). * Ran prettier against azureFirewall.json
Azure · Feb 7, 2024 · 9097c69 · 9097c69
1 parent 9381354
commit 9097c69
Show file tree

Hide file tree

Showing 19 changed files with 90 additions and 7 deletions.
diff --git a/...ification/network/resource-manager/Microsoft.Network/stable/2023-05-01/azureFirewall.json b/...ification/network/resource-manager/Microsoft.Network/stable/2023-05-01/azureFirewall.json
@@ -65,7 +65,13 @@
         ],
         "responses": {
           "202": {
-            "description": "Accepted and the operation will complete asynchronously."
+            "description": "Accepted and the operation will complete asynchronously.",
+            "headers": {
+              "Location": {
+                "description": "The URL of the resource used to check the status of the asynchronous operation.",
+                "type": "string"
+              }
+            }
           },
           "204": {
             "description": "Request successful. Resource with the specified name does not exist."
@@ -484,6 +490,7 @@
             "description": "Accepted and the operation will complete asynchronously.",
             "headers": {
               "Location": {
+                "description": "The URL of the resource used to check the status of the asynchronous operation.",
                 "type": "string"
               }
             }

diff --git a/...rk/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallDelete.json b/...rk/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallDelete.json
@@ -7,7 +7,11 @@
   },
   "responses": {
     "200": {},
-    "202": {},
+    "202": {
+      "headers": {
+        "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789"
+      }
+    },
     "204": {}
   }
 }
diff --git a/...twork/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json b/...twork/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGet.json
@@ -44,6 +44,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -74,6 +75,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -123,6 +125,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...icrosoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json b/...icrosoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithAdditionalProperties.json
@@ -44,6 +44,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -74,6 +75,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -123,6 +125,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...ce-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json b/...ce-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithIpGroups.json
@@ -44,6 +44,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -73,6 +74,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -122,6 +124,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json b/...-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithMgmtSubnet.json
@@ -58,6 +58,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -88,6 +89,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -137,6 +139,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...ource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json b/...ource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallGetWithZones.json
@@ -48,6 +48,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -78,6 +79,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -127,6 +129,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...anager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json b/...anager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListByResourceGroup.json
@@ -55,6 +55,7 @@
               "applicationRuleCollections": [
                 {
                   "name": "apprulecoll",
+                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
                   "properties": {
                     "priority": 110,
                     "action": {
@@ -85,6 +86,7 @@
               "natRuleCollections": [
                 {
                   "name": "natrulecoll",
+                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
                   "properties": {
                     "priority": 112,
                     "action": {
@@ -134,6 +136,7 @@
               "networkRuleCollections": [
                 {
                   "name": "netrulecoll",
+                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
                   "properties": {
                     "priority": 112,
                     "action": {

diff --git a/...manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json b/...manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListBySubscription.json
@@ -54,6 +54,7 @@
               "applicationRuleCollections": [
                 {
                   "name": "apprulecoll",
+                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
                   "properties": {
                     "priority": 110,
                     "action": {
@@ -84,6 +85,7 @@
               "natRuleCollections": [
                 {
                   "name": "natrulecoll",
+                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
                   "properties": {
                     "priority": 112,
                     "action": {
@@ -133,6 +135,7 @@
               "networkRuleCollections": [
                 {
                   "name": "netrulecoll",
+                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
                   "properties": {
                     "priority": 112,
                     "action": {

diff --git a/...ager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListLearnedIPPrefixes.json b/...ager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallListLearnedIPPrefixes.json
@@ -6,7 +6,11 @@
     "azureFirewallName": "azureFirewall1"
   },
   "responses": {
-    "202": {},
+    "202": {
+      "headers": {
+        "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789"
+      }
+    },
     "200": {
       "body": {
         "ipPrefixes": [

diff --git a/...twork/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json b/...twork/resource-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPut.json
@@ -198,6 +198,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -228,6 +229,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -277,6 +279,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -365,6 +368,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -395,6 +399,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -444,6 +449,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...icrosoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json b/...icrosoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithAdditionalProperties.json
@@ -203,6 +203,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -233,6 +234,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -282,6 +284,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -372,6 +375,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -402,6 +406,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -451,6 +456,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {

diff --git a/...ce-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json b/...ce-manager/Microsoft.Network/stable/2023-05-01/examples/AzureFirewallPutWithIpGroups.json
@@ -198,6 +198,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -228,6 +229,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -277,6 +279,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -364,6 +367,7 @@
           "applicationRuleCollections": [
             {
               "name": "apprulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll",
               "properties": {
                 "priority": 110,
                 "action": {
@@ -393,6 +397,7 @@
           "natRuleCollections": [
             {
               "name": "natrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {
@@ -442,6 +447,7 @@
           "networkRuleCollections": [
             {
               "name": "netrulecoll",
+              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll",
               "properties": {
                 "priority": 112,
                 "action": {