ProviderHub: Swagger doc update (Azure#12680)

* RPaaS 2020.11.20 GA specs * update readme * prettier fix and add custom words * spelling * update SDKs * go sdk * update providerhub swagger * resolve circular dependency * validations fix * camel case * resource type registrations operationIds * linter * update readme * fix validation * update property * required request body parameters * update path * update response payload Co-authored-by: Wendy Chang <wendychang@microsoft.com> Co-authored-by: Wendy Chang <wendychang@gmail.com>
mkarmark · Jul 20, 2021 · 2949127 · 2949127
1 parent d704f2d
commit 2949127
Show file tree

Hide file tree

Showing 19 changed files with 299 additions and 210 deletions.
diff --git a/...ub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CheckinManifest.json b/...ub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CheckinManifest.json
@@ -3,8 +3,10 @@
     "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77",
     "providerNamespace": "Microsoft.Contoso",
     "api-version": "2020-11-20",
-    "BaselineArmManifestLocation": "EastUS2EUAP",
-    "Environment": "Prod"
+    "checkinManifestParams": {
+      "baselineArmManifestLocation": "EastUS2EUAP",
+      "environment": "Prod"
+    }
   },
   "responses": {
     "200": {

diff --git a/...nager/Microsoft.ProviderHub/stable/2020-11-20/examples/CustomRollouts_CreateOrUpdate.json b/...nager/Microsoft.ProviderHub/stable/2020-11-20/examples/CustomRollouts_CreateOrUpdate.json
@@ -4,14 +4,12 @@
     "providerNamespace": "Microsoft.Contoso",
     "rolloutName": "brazilUsShoeBoxTesting",
     "api-version": "2020-11-20",
-    "customRolloutSpecification": {
-      "properties": {
-        "specification": {
-          "Canary": {
-            "regions": [
-              "brazilus"
-            ]
-          }
+    "properties": {
+      "specification": {
+        "canary": {
+          "regions": [
+            "brazilus"
+          ]
         }
       }
     }

diff --git a/...soft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_CreateOrUpdate.json b/...soft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_CreateOrUpdate.json
@@ -4,28 +4,30 @@
     "providerNamespace": "Microsoft.Contoso",
     "api-version": "2020-11-20",
     "notificationRegistrationName": "fooNotificationRegistration",
-    "NotificationRegistrationProperties": {
-      "notificationMode": "EventHub",
-      "messageScope": "RegisteredSubscriptions",
-      "includedEvents": [
-        "*/write",
-        "Microsoft.Contoso/employees/delete"
-      ],
-      "notificationEndpoints": [
-        {
-          "locations": [
-            "",
-            "East US"
-          ],
-          "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"
-        },
-        {
-          "locations": [
-            "North Europe"
-          ],
-          "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"
-        }
-      ]
+    "properties": {
+      "properties": {
+        "notificationMode": "EventHub",
+        "messageScope": "RegisteredSubscriptions",
+        "includedEvents": [
+          "*/write",
+          "Microsoft.Contoso/employees/delete"
+        ],
+        "notificationEndpoints": [
+          {
+            "locations": [
+              "",
+              "East US"
+            ],
+            "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"
+          },
+          {
+            "locations": [
+              "North Europe"
+            ],
+            "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"
+          }
+        ]
+      }
     }
   },
   "responses": {

diff --git a/...e-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Operations_CreateOrUpdate.json b/...e-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Operations_CreateOrUpdate.json
@@ -3,15 +3,15 @@
     "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77",
     "providerNamespace": "Microsoft.Contoso",
     "api-version": "2020-11-20",
-    "OperationsContent": {
-      "Contents": [
+    "OperationsPutContent": {
+      "contents": [
         {
-          "Name": "Microsoft.Contoso/Employees/Read",
-          "Display": {
-            "Provider": "Microsoft.Contoso",
-            "Resource": "Employees",
-            "Operation": "Gets/List employee resources",
-            "Description": "Read employees"
+          "name": "Microsoft.Contoso/Employees/Read",
+          "display": {
+            "provider": "Microsoft.Contoso",
+            "resource": "Employees",
+            "operation": "Gets/List employee resources",
+            "description": "Read employees"
           }
         }
       ]

diff --git a/...icrosoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_CreateOrUpdate.json b/...icrosoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_CreateOrUpdate.json
@@ -3,7 +3,7 @@
     "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77",
     "providerNamespace": "Microsoft.Contoso",
     "api-version": "2020-11-20",
-    "ProviderRegistration": {
+    "properties": {
       "properties": {
         "providerType": "Internal",
         "providerVersion": "2.0",

diff --git a/...oft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_ListByResourceGroup.json b/...oft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_ListByResourceGroup.json
diff --git a/...ourceTypeRegistration_CreateOrUpdate.json → ...urceTypeRegistrations_CreateOrUpdate.json b/...ourceTypeRegistration_CreateOrUpdate.json → ...urceTypeRegistrations_CreateOrUpdate.json
@@ -4,10 +4,10 @@
     "providerNamespace": "Microsoft.Contoso",
     "resourceType": "employees",
     "api-version": "2020-11-20",
-    "ResourceTypeRegistration": {
+    "properties": {
       "properties": {
         "routingType": "Default",
-        "regionality": "regional",
+        "regionality": "Regional",
         "endpoints": [
           {
             "apiVersions": [
@@ -18,7 +18,7 @@
               "East US",
               "North Europe"
             ],
-            "requiredfeatures": [
+            "requiredFeatures": [
               "<feature flag>"
             ]
           }

diff --git a/...ples/ResourceTypeRegistration_Delete.json → ...les/ResourceTypeRegistrations_Delete.json b/...ples/ResourceTypeRegistration_Delete.json → ...les/ResourceTypeRegistrations_Delete.json
diff --git a/...esource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdate.json b/...esource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdate.json
@@ -5,26 +5,24 @@
     "api-version": "2020-11-20",
     "resourceType": "testResourceType",
     "sku": "testSku",
-    "SkuResource": {
-      "properties": {
-        "skuSettings": [
-          {
-            "name": "freeSku",
-            "tier": "Tier1",
-            "kind": "Standard"
-          },
-          {
-            "name": "premiumSku",
-            "tier": "Tier2",
-            "kind": "Premium",
-            "costs": [
-              {
-                "meterId": "xxx"
-              }
-            ]
-          }
-        ]
-      }
+    "properties": {
+      "skuSettings": [
+        {
+          "name": "freeSku",
+          "tier": "Tier1",
+          "kind": "Standard"
+        },
+        {
+          "name": "premiumSku",
+          "tier": "Tier2",
+          "kind": "Premium",
+          "costs": [
+            {
+              "meterId": "xxx"
+            }
+          ]
+        }
+      ]
     }
   },
   "responses": {

diff --git a/...ft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json b/...ft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json
@@ -6,26 +6,24 @@
     "resourceType": "testResourceType",
     "sku": "testSku",
     "nestedResourceTypeFirst": "nestedResourceTypeFirst",
-    "SkuResource": {
-      "properties": {
-        "skuSettings": [
-          {
-            "name": "freeSku",
-            "tier": "Tier1",
-            "kind": "Standard"
-          },
-          {
-            "name": "premiumSku",
-            "tier": "Tier2",
-            "kind": "Premium",
-            "costs": [
-              {
-                "meterId": "xxx"
-              }
-            ]
-          }
-        ]
-      }
+    "properties": {
+      "skuSettings": [
+        {
+          "name": "freeSku",
+          "tier": "Tier1",
+          "kind": "Standard"
+        },
+        {
+          "name": "premiumSku",
+          "tier": "Tier2",
+          "kind": "Premium",
+          "costs": [
+            {
+              "meterId": "xxx"
+            }
+          ]
+        }
+      ]
     }
   },
   "responses": {

diff --git a/...t.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json b/...t.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json
@@ -7,26 +7,24 @@
     "sku": "testSku",
     "nestedResourceTypeFirst": "nestedResourceTypeFirst",
     "nestedResourceTypeSecond": "nestedResourceTypeSecond",
-    "SkuResource": {
-      "properties": {
-        "skuSettings": [
-          {
-            "name": "freeSku",
-            "tier": "Tier1",
-            "kind": "Standard"
-          },
-          {
-            "name": "premiumSku",
-            "tier": "Tier2",
-            "kind": "Premium",
-            "costs": [
-              {
-                "meterId": "xxx"
-              }
-            ]
-          }
-        ]
-      }
+    "properties": {
+      "skuSettings": [
+        {
+          "name": "freeSku",
+          "tier": "Tier1",
+          "kind": "Standard"
+        },
+        {
+          "name": "premiumSku",
+          "tier": "Tier2",
+          "kind": "Premium",
+          "costs": [
+            {
+              "meterId": "xxx"
+            }
+          ]
+        }
+      ]
     }
   },
   "responses": {

diff --git a/...ft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json b/...ft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json
@@ -8,26 +8,24 @@
     "nestedResourceTypeFirst": "nestedResourceTypeFirst",
     "nestedResourceTypeSecond": "nestedResourceTypeSecond",
     "nestedResourceTypeThird": "nestedResourceTypeThird",
-    "SkuResource": {
-      "properties": {
-        "skuSettings": [
-          {
-            "name": "freeSku",
-            "tier": "Tier1",
-            "kind": "Standard"
-          },
-          {
-            "name": "premiumSku",
-            "tier": "Tier2",
-            "kind": "Premium",
-            "costs": [
-              {
-                "meterId": "xxx"
-              }
-            ]
-          }
-        ]
-      }
+    "properties": {
+      "skuSettings": [
+        {
+          "name": "freeSku",
+          "tier": "Tier1",
+          "kind": "Standard"
+        },
+        {
+          "name": "premiumSku",
+          "tier": "Tier2",
+          "kind": "Premium",
+          "costs": [
+            {
+              "meterId": "xxx"
+            }
+          ]
+        }
+      ]
     }
   },
   "responses": {