[Purview Accounts] SDK Team Feedback on Operation IDs (Azure#15669)

This change updates the operation ids for operations in the Purview Accounts service. These names are used when generating clients and so for some we've added suffxes (based on their groupings) to make generated method names a little clearler when you see just the method name in code e.g.: ``` var client = new PurviewAccountsClient(); ... client.GetAccountProperties() // Nicer than just client.Get(); ``` In addition, we noticed that the `Collections_GetCollectionPath` operation took a `$skipToken` parameter, even though the operation is not pageable. After following up with the service team we learned this was a mistake, so I have removed the parameter from the specification.
AzureSDKAutomation · Aug 18, 2021 · 1325617 · 1325617
1 parent 60d6c39
commit 1325617
Show file tree

Hide file tree

Showing 15 changed files with 52 additions and 44 deletions.
diff --git a/...urview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json b/...urview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json
@@ -31,7 +31,7 @@
           "Account"
         ],
         "description": "Get an account",
-        "operationId": "Accounts_Get",
+        "operationId": "Accounts_GetAccountProperties",
         "parameters": [
           {
             "$ref": "#/parameters/api-version"
@@ -52,8 +52,8 @@
           }
         },
         "x-ms-examples": {
-          "Accounts_Get": {
-            "$ref": "./examples/Accounts_Get.json"
+          "Accounts_GetAccountProperties": {
+            "$ref": "./examples/Accounts_GetAccountProperties.json"
           }
         }
       },
@@ -62,7 +62,7 @@
           "Account"
         ],
         "description": "Updates an account",
-        "operationId": "Accounts_Update",
+        "operationId": "Accounts_UpdateAccountProperties",
         "parameters": [
           {
             "name": "accountUpdateParameters",
@@ -91,8 +91,8 @@
           }
         },
         "x-ms-examples": {
-          "Accounts_Update": {
-            "$ref": "./examples/Accounts_Update.json"
+          "Accounts_UpdateAccountProperties": {
+            "$ref": "./examples/Accounts_UpdateAccountProperties.json"
           }
         }
       }
@@ -103,7 +103,7 @@
           "Account"
         ],
         "description": "List the authorization keys associated with this account.",
-        "operationId": "Accounts_ListKeys",
+        "operationId": "Accounts_GetAccessKeys",
         "parameters": [
           {
             "$ref": "#/parameters/api-version"
@@ -124,8 +124,8 @@
           }
         },
         "x-ms-examples": {
-          "Accounts_ListKeys": {
-            "$ref": "./examples/Accounts_ListKeys.json"
+          "Accounts_GetAccessKeys": {
+            "$ref": "./examples/Accounts_GetAccessKeys.json"
           }
         }
       }
@@ -136,7 +136,7 @@
           "Account"
         ],
         "description": "Regenerate the authorization keys associated with this data catalog.",
-        "operationId": "Accounts_RegenerateKeys",
+        "operationId": "Accounts_RegenerateAccessKey",
         "parameters": [
           {
             "name": "keyOptions",
@@ -166,7 +166,7 @@
         },
         "x-ms-examples": {
           "Accounts_RegenerateKeys": {
-            "$ref": "./examples/Accounts_RegenerateKeys.json"
+            "$ref": "./examples/Accounts_RegenerateAccessKey.json"
           }
         }
       }
@@ -177,7 +177,7 @@
           "Collection"
         ],
         "description": "Get a collection",
-        "operationId": "Collections_Get",
+        "operationId": "Collections_GetCollection",
         "parameters": [
           {
             "name": "collectionName",
@@ -204,8 +204,8 @@
           }
         },
         "x-ms-examples": {
-          "Collections_Get": {
-            "$ref": "./examples/Collections_Get.json"
+          "Collections_GetCollection": {
+            "$ref": "./examples/Collections_GetCollection.json"
           }
         }
       },
@@ -214,7 +214,7 @@
           "Collection"
         ],
         "description": "Creates or updates a collection entity.",
-        "operationId": "Collections_CreateOrUpdate",
+        "operationId": "Collections_CreateOrUpdateCollection",
         "parameters": [
           {
             "name": "collectionName",
@@ -249,8 +249,8 @@
           }
         },
         "x-ms-examples": {
-          "Collections_CreateOrUpdate": {
-            "$ref": "./examples/Collections_CreateOrUpdate.json"
+          "Collections_CreateOrUpdateCollection": {
+            "$ref": "./examples/Collections_CreateOrUpdateCollection.json"
           }
         }
       },
@@ -259,7 +259,7 @@
           "Collection"
         ],
         "description": "Deletes a Collection entity.",
-        "operationId": "Collections_Delete",
+        "operationId": "Collections_DeleteCollection",
         "parameters": [
           {
             "name": "collectionName",
@@ -283,8 +283,8 @@
           }
         },
         "x-ms-examples": {
-          "Collections_Delete": {
-            "$ref": "./examples/Collections_Delete.json"
+          "Collections_DeleteCollection": {
+            "$ref": "./examples/Collections_DeleteCollection.json"
           }
         }
       }
@@ -295,7 +295,7 @@
           "Collection"
         ],
         "description": "List the collections in the account.",
-        "operationId": "Collections_ListByAccount",
+        "operationId": "Collections_ListCollections",
         "parameters": [
           {
             "$ref": "#/parameters/api-version"
@@ -325,8 +325,8 @@
           "nextLinkName": "nextLink"
         },
         "x-ms-examples": {
-          "Collections_ListByAccount": {
-            "$ref": "./examples/Collections_ListByAccount.json"
+          "Collections_ListCollections": {
+            "$ref": "./examples/Collections_ListCollections.json"
           }
         }
       }
@@ -337,7 +337,7 @@
           "Collection"
         ],
         "description": "Lists the child collections names in the collection.",
-        "operationId": "Collections_GetChildCollectionNames",
+        "operationId": "Collections_ListChildCollectionNames",
         "parameters": [
           {
             "name": "collectionName",
@@ -373,8 +373,8 @@
           "nextLinkName": "nextLink"
         },
         "x-ms-examples": {
-          "Collections_GetChildCollectionNames": {
-            "$ref": "./examples/Collections_GetChildCollectionNames.json"
+          "Collections_ListChildCollectionNames": {
+            "$ref": "./examples/Collections_ListChildCollectionNames.json"
           }
         }
       }
@@ -395,12 +395,6 @@
           },
           {
             "$ref": "#/parameters/api-version"
-          },
-          {
-            "name": "$skipToken",
-            "in": "query",
-            "required": false,
-            "type": "string"
           }
         ],
         "responses": {
@@ -430,7 +424,7 @@
           "ResourceSetRuleConfig"
         ],
         "description": "Get a resource set config service model.",
-        "operationId": "ResourceSetRuleConfigs_Get",
+        "operationId": "ResourceSetRules_GetResourceSetRule",
         "parameters": [
           {
             "$ref": "#/parameters/api-version"
@@ -451,8 +445,8 @@
           }
         },
         "x-ms-examples": {
-          "ResourceSetRuleConfigs_Get": {
-            "$ref": "./examples/ResourceSetRuleConfigs_Get.json"
+          "ResourceSetRules_GetResourceSetRule": {
+            "$ref": "./examples/ResourceSetRules_GetResourceSetRule.json"
           }
         }
       },
@@ -461,7 +455,7 @@
           "ResourceSetRuleConfig"
         ],
         "description": "Creates or updates an resource set config.",
-        "operationId": "ResourceSetRuleConfigs_CreateOrUpdate",
+        "operationId": "ResourceSetRules_CreateOrUpdateResourceSetRule",
         "parameters": [
           {
             "name": "resourceSetRuleConfig",
@@ -490,8 +484,8 @@
           }
         },
         "x-ms-examples": {
-          "ResourceSetRuleConfigs_CreateOrUpdate": {
-            "$ref": "./examples/ResourceSetRuleConfigs_CreateOrUpdate.json"
+          "ResourceSetRules_CreateOrUpdateResourceSetRule": {
+            "$ref": "./examples/ResourceSetRules_CreateOrUpdateResourceSetRule.json"
           }
         }
       },
@@ -500,7 +494,7 @@
           "ResourceSetRuleConfig"
         ],
         "description": "Deletes a ResourceSetRuleConfig resource.",
-        "operationId": "ResourceSetRuleConfigs_Delete",
+        "operationId": "ResourceSetRules_DeleteResourceSetRule",
         "parameters": [
           {
             "$ref": "#/parameters/api-version"
@@ -521,8 +515,8 @@
           }
         },
         "x-ms-examples": {
-          "ResourceSetRuleConfigs_Delete": {
-            "$ref": "./examples/ResourceSetRuleConfigs_Delete.json"
+          "ResourceSetRules_DeleteResourceSetRule": {
+            "$ref": "./examples/ResourceSetRules_DeleteResourceSetRule.json"
           }
         }
       }
@@ -533,7 +527,7 @@
           "ResourceSetRuleConfig"
         ],
         "description": "Get a resource set config service model.",
-        "operationId": "ResourceSetRuleConfigs_ListByAccount",
+        "operationId": "ResourceSetRules_ListResourceSetRules",
         "parameters": [
           {
             "$ref": "#/parameters/api-version"
@@ -563,8 +557,8 @@
           "nextLinkName": "nextLink"
         },
         "x-ms-examples": {
-          "ResourceSetRuleConfigs_ListByAccount": {
-            "$ref": "./examples/ResourceSetRuleConfigs_ListByAccount.json"
+          "ResourceSetRules_ListResourceSetRules": {
+            "$ref": "./examples/ResourceSetRules_ListResourceSetRules.json"
           }
         }
       }

diff --git a/...1-preview/examples/Accounts_ListKeys.json → ...view/examples/Accounts_GetAccessKeys.json b/...1-preview/examples/Accounts_ListKeys.json → ...view/examples/Accounts_GetAccessKeys.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "api-version": "2018-12-01-preview"
   },
   "responses": {

diff --git a/...-11-01-preview/examples/Accounts_Get.json → ...amples/Accounts_GetAccountProperties.json b/...-11-01-preview/examples/Accounts_Get.json → ...amples/Accounts_GetAccountProperties.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "api-version": "2018-12-01-preview"
   },
   "responses": {

diff --git a/...iew/examples/Accounts_RegenerateKeys.json → ...xamples/Accounts_RegenerateAccessKey.json b/...iew/examples/Accounts_RegenerateKeys.json → ...xamples/Accounts_RegenerateAccessKey.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "api-version": "2018-12-01-preview",
     "keyOptions": {
       "keyType": "PrimaryKey"

diff --git a/...-01-preview/examples/Accounts_Update.json → ...les/Accounts_UpdateAccountProperties.json b/...-01-preview/examples/Accounts_Update.json → ...les/Accounts_UpdateAccountProperties.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
     "resourceGroupName": "SampleResourceGroup",
     "accountName": "account1",

diff --git a/.../examples/Collections_CreateOrUpdate.json → ...Collections_CreateOrUpdateCollection.json b/.../examples/Collections_CreateOrUpdate.json → ...Collections_CreateOrUpdateCollection.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "collectionName": "myCollection1",
     "api-version": "2019-11-01-preview",
     "collection": {

diff --git a/...-preview/examples/Collections_Delete.json → ...xamples/Collections_DeleteCollection.json b/...-preview/examples/Collections_Delete.json → ...xamples/Collections_DeleteCollection.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "collectionName": "myCollection1",
     "api-version": "2019-11-01-preview"
   },

diff --git a/...-01-preview/examples/Collections_Get.json → ...w/examples/Collections_GetCollection.json b/...-01-preview/examples/Collections_Get.json → ...w/examples/Collections_GetCollection.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "collectionName": "myCollection1",
     "api-version": "2019-11-01-preview"
   },

diff --git a/...cs.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollectionPath.json b/...cs.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollectionPath.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "collectionName": "myCollection1",
     "api-version": "2019-11-01-preview"
   },

diff --git a/.../Collections_GetChildCollectionNames.json → ...Collections_ListChildCollectionNames.json b/.../Collections_GetChildCollectionNames.json → ...Collections_ListChildCollectionNames.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "collectionName": "myCollection1",
     "api-version": "2019-11-01-preview"
   },

diff --git a/...w/examples/Collections_ListByAccount.json → ...examples/Collections_ListCollections.json b/...w/examples/Collections_ListByAccount.json → ...examples/Collections_ListCollections.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "api-version": "2019-11-01-preview"
   },
   "responses": {

diff --git a/...esourceSetRuleConfigs_CreateOrUpdate.json → ...tRules_CreateOrUpdateResourceSetRule.json b/...esourceSetRuleConfigs_CreateOrUpdate.json → ...tRules_CreateOrUpdateResourceSetRule.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b",
     "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName",
     "api-version": "2019-11-01-preview",

diff --git a/...amples/ResourceSetRuleConfigs_Delete.json → ...sourceSetRules_DeleteResourceSetRule.json b/...amples/ResourceSetRuleConfigs_Delete.json → ...sourceSetRules_DeleteResourceSetRule.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b",
     "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName",
     "api-version": "2019-11-01-preview"

diff --git a/.../examples/ResourceSetRuleConfigs_Get.json → .../ResourceSetRules_GetResourceSetRule.json b/.../examples/ResourceSetRuleConfigs_Get.json → .../ResourceSetRules_GetResourceSetRule.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b",
     "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName",
     "api-version": "2019-11-01-preview"

diff --git a/...ResourceSetRuleConfigs_ListByAccount.json → ...esourceSetRules_ListResourceSetRules.json b/...ResourceSetRuleConfigs_ListByAccount.json → ...esourceSetRules_ListResourceSetRules.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "endpoint": "{endpoint}",
     "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b",
     "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName",
     "api-version": "2019-11-01-preview"