Skip to content

Commit 1325617

Browse files
ellismgellismg
authored
[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.
1 parent 60d6c39 commit 1325617

15 files changed

+52
-44
lines changed

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json‎

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"Account"
3232
],
3333
"description": "Get an account",
34-
"operationId": "Accounts_Get",
34+
"operationId": "Accounts_GetAccountProperties",
3535
"parameters": [
3636
{
3737
"$ref": "#/parameters/api-version"
@@ -52,8 +52,8 @@
5252
}
5353
},
5454
"x-ms-examples": {
55-
"Accounts_Get": {
56-
"$ref": "./examples/Accounts_Get.json"
55+
"Accounts_GetAccountProperties": {
56+
"$ref": "./examples/Accounts_GetAccountProperties.json"
5757
}
5858
}
5959
},
@@ -62,7 +62,7 @@
6262
"Account"
6363
],
6464
"description": "Updates an account",
65-
"operationId": "Accounts_Update",
65+
"operationId": "Accounts_UpdateAccountProperties",
6666
"parameters": [
6767
{
6868
"name": "accountUpdateParameters",
@@ -91,8 +91,8 @@
9191
}
9292
},
9393
"x-ms-examples": {
94-
"Accounts_Update": {
95-
"$ref": "./examples/Accounts_Update.json"
94+
"Accounts_UpdateAccountProperties": {
95+
"$ref": "./examples/Accounts_UpdateAccountProperties.json"
9696
}
9797
}
9898
}
@@ -103,7 +103,7 @@
103103
"Account"
104104
],
105105
"description": "List the authorization keys associated with this account.",
106-
"operationId": "Accounts_ListKeys",
106+
"operationId": "Accounts_GetAccessKeys",
107107
"parameters": [
108108
{
109109
"$ref": "#/parameters/api-version"
@@ -124,8 +124,8 @@
124124
}
125125
},
126126
"x-ms-examples": {
127-
"Accounts_ListKeys": {
128-
"$ref": "./examples/Accounts_ListKeys.json"
127+
"Accounts_GetAccessKeys": {
128+
"$ref": "./examples/Accounts_GetAccessKeys.json"
129129
}
130130
}
131131
}
@@ -136,7 +136,7 @@
136136
"Account"
137137
],
138138
"description": "Regenerate the authorization keys associated with this data catalog.",
139-
"operationId": "Accounts_RegenerateKeys",
139+
"operationId": "Accounts_RegenerateAccessKey",
140140
"parameters": [
141141
{
142142
"name": "keyOptions",
@@ -166,7 +166,7 @@
166166
},
167167
"x-ms-examples": {
168168
"Accounts_RegenerateKeys": {
169-
"$ref": "./examples/Accounts_RegenerateKeys.json"
169+
"$ref": "./examples/Accounts_RegenerateAccessKey.json"
170170
}
171171
}
172172
}
@@ -177,7 +177,7 @@
177177
"Collection"
178178
],
179179
"description": "Get a collection",
180-
"operationId": "Collections_Get",
180+
"operationId": "Collections_GetCollection",
181181
"parameters": [
182182
{
183183
"name": "collectionName",
@@ -204,8 +204,8 @@
204204
}
205205
},
206206
"x-ms-examples": {
207-
"Collections_Get": {
208-
"$ref": "./examples/Collections_Get.json"
207+
"Collections_GetCollection": {
208+
"$ref": "./examples/Collections_GetCollection.json"
209209
}
210210
}
211211
},
@@ -214,7 +214,7 @@
214214
"Collection"
215215
],
216216
"description": "Creates or updates a collection entity.",
217-
"operationId": "Collections_CreateOrUpdate",
217+
"operationId": "Collections_CreateOrUpdateCollection",
218218
"parameters": [
219219
{
220220
"name": "collectionName",
@@ -249,8 +249,8 @@
249249
}
250250
},
251251
"x-ms-examples": {
252-
"Collections_CreateOrUpdate": {
253-
"$ref": "./examples/Collections_CreateOrUpdate.json"
252+
"Collections_CreateOrUpdateCollection": {
253+
"$ref": "./examples/Collections_CreateOrUpdateCollection.json"
254254
}
255255
}
256256
},
@@ -259,7 +259,7 @@
259259
"Collection"
260260
],
261261
"description": "Deletes a Collection entity.",
262-
"operationId": "Collections_Delete",
262+
"operationId": "Collections_DeleteCollection",
263263
"parameters": [
264264
{
265265
"name": "collectionName",
@@ -283,8 +283,8 @@
283283
}
284284
},
285285
"x-ms-examples": {
286-
"Collections_Delete": {
287-
"$ref": "./examples/Collections_Delete.json"
286+
"Collections_DeleteCollection": {
287+
"$ref": "./examples/Collections_DeleteCollection.json"
288288
}
289289
}
290290
}
@@ -295,7 +295,7 @@
295295
"Collection"
296296
],
297297
"description": "List the collections in the account.",
298-
"operationId": "Collections_ListByAccount",
298+
"operationId": "Collections_ListCollections",
299299
"parameters": [
300300
{
301301
"$ref": "#/parameters/api-version"
@@ -325,8 +325,8 @@
325325
"nextLinkName": "nextLink"
326326
},
327327
"x-ms-examples": {
328-
"Collections_ListByAccount": {
329-
"$ref": "./examples/Collections_ListByAccount.json"
328+
"Collections_ListCollections": {
329+
"$ref": "./examples/Collections_ListCollections.json"
330330
}
331331
}
332332
}
@@ -337,7 +337,7 @@
337337
"Collection"
338338
],
339339
"description": "Lists the child collections names in the collection.",
340-
"operationId": "Collections_GetChildCollectionNames",
340+
"operationId": "Collections_ListChildCollectionNames",
341341
"parameters": [
342342
{
343343
"name": "collectionName",
@@ -373,8 +373,8 @@
373373
"nextLinkName": "nextLink"
374374
},
375375
"x-ms-examples": {
376-
"Collections_GetChildCollectionNames": {
377-
"$ref": "./examples/Collections_GetChildCollectionNames.json"
376+
"Collections_ListChildCollectionNames": {
377+
"$ref": "./examples/Collections_ListChildCollectionNames.json"
378378
}
379379
}
380380
}
@@ -395,12 +395,6 @@
395395
},
396396
{
397397
"$ref": "#/parameters/api-version"
398-
},
399-
{
400-
"name": "$skipToken",
401-
"in": "query",
402-
"required": false,
403-
"type": "string"
404398
}
405399
],
406400
"responses": {
@@ -430,7 +424,7 @@
430424
"ResourceSetRuleConfig"
431425
],
432426
"description": "Get a resource set config service model.",
433-
"operationId": "ResourceSetRuleConfigs_Get",
427+
"operationId": "ResourceSetRules_GetResourceSetRule",
434428
"parameters": [
435429
{
436430
"$ref": "#/parameters/api-version"
@@ -451,8 +445,8 @@
451445
}
452446
},
453447
"x-ms-examples": {
454-
"ResourceSetRuleConfigs_Get": {
455-
"$ref": "./examples/ResourceSetRuleConfigs_Get.json"
448+
"ResourceSetRules_GetResourceSetRule": {
449+
"$ref": "./examples/ResourceSetRules_GetResourceSetRule.json"
456450
}
457451
}
458452
},
@@ -461,7 +455,7 @@
461455
"ResourceSetRuleConfig"
462456
],
463457
"description": "Creates or updates an resource set config.",
464-
"operationId": "ResourceSetRuleConfigs_CreateOrUpdate",
458+
"operationId": "ResourceSetRules_CreateOrUpdateResourceSetRule",
465459
"parameters": [
466460
{
467461
"name": "resourceSetRuleConfig",
@@ -490,8 +484,8 @@
490484
}
491485
},
492486
"x-ms-examples": {
493-
"ResourceSetRuleConfigs_CreateOrUpdate": {
494-
"$ref": "./examples/ResourceSetRuleConfigs_CreateOrUpdate.json"
487+
"ResourceSetRules_CreateOrUpdateResourceSetRule": {
488+
"$ref": "./examples/ResourceSetRules_CreateOrUpdateResourceSetRule.json"
495489
}
496490
}
497491
},
@@ -500,7 +494,7 @@
500494
"ResourceSetRuleConfig"
501495
],
502496
"description": "Deletes a ResourceSetRuleConfig resource.",
503-
"operationId": "ResourceSetRuleConfigs_Delete",
497+
"operationId": "ResourceSetRules_DeleteResourceSetRule",
504498
"parameters": [
505499
{
506500
"$ref": "#/parameters/api-version"
@@ -521,8 +515,8 @@
521515
}
522516
},
523517
"x-ms-examples": {
524-
"ResourceSetRuleConfigs_Delete": {
525-
"$ref": "./examples/ResourceSetRuleConfigs_Delete.json"
518+
"ResourceSetRules_DeleteResourceSetRule": {
519+
"$ref": "./examples/ResourceSetRules_DeleteResourceSetRule.json"
526520
}
527521
}
528522
}
@@ -533,7 +527,7 @@
533527
"ResourceSetRuleConfig"
534528
],
535529
"description": "Get a resource set config service model.",
536-
"operationId": "ResourceSetRuleConfigs_ListByAccount",
530+
"operationId": "ResourceSetRules_ListResourceSetRules",
537531
"parameters": [
538532
{
539533
"$ref": "#/parameters/api-version"
@@ -563,8 +557,8 @@
563557
"nextLinkName": "nextLink"
564558
},
565559
"x-ms-examples": {
566-
"ResourceSetRuleConfigs_ListByAccount": {
567-
"$ref": "./examples/ResourceSetRuleConfigs_ListByAccount.json"
560+
"ResourceSetRules_ListResourceSetRules": {
561+
"$ref": "./examples/ResourceSetRules_ListResourceSetRules.json"
568562
}
569563
}
570564
}

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_ListKeys.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_GetAccessKeys.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"api-version": "2018-12-01-preview"
45
},
56
"responses": {

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Get.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_GetAccountProperties.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"api-version": "2018-12-01-preview"
45
},
56
"responses": {

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_RegenerateKeys.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_RegenerateAccessKey.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"api-version": "2018-12-01-preview",
45
"keyOptions": {
56
"keyType": "PrimaryKey"

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Update.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_UpdateAccountProperties.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
45
"resourceGroupName": "SampleResourceGroup",
56
"accountName": "account1",

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_CreateOrUpdate.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_CreateOrUpdateCollection.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"collectionName": "myCollection1",
45
"api-version": "2019-11-01-preview",
56
"collection": {

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Delete.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_DeleteCollection.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"collectionName": "myCollection1",
45
"api-version": "2019-11-01-preview"
56
},

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Get.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollection.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"collectionName": "myCollection1",
45
"api-version": "2019-11-01-preview"
56
},

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollectionPath.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"collectionName": "myCollection1",
45
"api-version": "2019-11-01-preview"
56
},

‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetChildCollectionNames.json‎ renamed to ‎specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_ListChildCollectionNames.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"parameters": {
3+
"endpoint": "{endpoint}",
34
"collectionName": "myCollection1",
45
"api-version": "2019-11-01-preview"
56
},

0 commit comments

Comments
 (0)