From a6f55a414702190b191c3f886673887ca1b7bafa Mon Sep 17 00:00:00 2001 From: David Burg <12040431+daviburg@users.noreply.github.com> Date: Fri, 31 Jul 2026 13:46:16 -0700 Subject: [PATCH] Regenerate Sql, AzureAD and Mq with documentation version affixes aligned Version affixes are stripped from identifiers but survived in the documentation derived from the swagger summary and description, so `SqlExtensions` emitted `public class GetTablesResponse` documented as `Response for Get tables (V2)`. AzureUX-BPM PR 16648499 aligns the prose with the identifier actually emitted. These three clients are the demonstrating set for that fix, chosen to exercise all three behaviours rather than to be exhaustive: - Sql 28 -> 2. The motivating example. - Mq 17 -> 0. Uses lowercase `(v2)`, matched case-insensitively. - AzureAD 5 -> 1. Four affixes dropped where the identifier was simplified; the one that remains documents `GetMemberGroupsResponseV2`, which kept its affix, so its summary must keep it too or it becomes indistinguishable from its sibling. Documentation-comment only: all 94 changed lines are doc comments, with no identifier, signature or wire change. Sql was held back while the Purview identifier correction was in flight as #227. That merged, so Sql now regenerates clean and is included. The remaining affected clients settle in the planned full sweep. Build: 0 errors, 0 warnings. Tests: 935 passed, 0 failed. Co-authored-by: Dobby --- .../Generated/AzureADExtensions.cs | 8 +-- .../Generated/MqExtensions.cs | 34 ++++++------ .../Generated/SqlExtensions.cs | 52 +++++++++---------- 3 files changed, 47 insertions(+), 47 deletions(-) diff --git a/src/Azure.Connectors.Sdk/Generated/AzureADExtensions.cs b/src/Azure.Connectors.Sdk/Generated/AzureADExtensions.cs index d75d6ab..2f3751f 100644 --- a/src/Azure.Connectors.Sdk/Generated/AzureADExtensions.cs +++ b/src/Azure.Connectors.Sdk/Generated/AzureADExtensions.cs @@ -1210,13 +1210,13 @@ public virtual async Task CreateGroupAsync(CreateGroupInput } /// - /// Check group membership (V2) + /// Check group membership /// /// If the user is a member of the given group, the result will contain the given id. Otherwise the result will be empty. /// User Id or Principal Name /// The request body. /// Cancellation token. - /// The Check group membership (V2) response. + /// The Check group membership response. public virtual async Task CheckMemberGroupsAsync(string userIdOrPrincipalName, CheckMemberGroupsRequest input, CancellationToken cancellationToken = default) { using var activity = AzureADClient.ConnectorActivitySource.StartActivity("AzureADClient.CheckMemberGroupsAsync"); @@ -1238,13 +1238,13 @@ public virtual async Task CheckMemberGroupsAsync(stri } /// - /// Get groups of a user (V2) + /// Get groups of a user /// /// Get the groups a user is a member of. /// User Id or Principal Name /// The request body. /// Cancellation token. - /// The Get groups of a user (V2) response. + /// The Get groups of a user response. public virtual async Task GetMemberGroupsAsync(string userIdOrPrincipalName, GetMemberGroupsRequest input, CancellationToken cancellationToken = default) { using var activity = AzureADClient.ConnectorActivitySource.StartActivity("AzureADClient.GetMemberGroupsAsync"); diff --git a/src/Azure.Connectors.Sdk/Generated/MqExtensions.cs b/src/Azure.Connectors.Sdk/Generated/MqExtensions.cs index 612c07e..ac1b3ca 100644 --- a/src/Azure.Connectors.Sdk/Generated/MqExtensions.cs +++ b/src/Azure.Connectors.Sdk/Generated/MqExtensions.cs @@ -29,7 +29,7 @@ namespace Azure.Connectors.Sdk.Mq.Models #region Types /// - /// Response for Delete message (v2) + /// Response for Delete message /// public class Item { @@ -116,7 +116,7 @@ public class Item } /// - /// Response for Delete messages (v2) + /// Response for Delete messages /// public class ItemsList { @@ -126,7 +126,7 @@ public class ItemsList } /// - /// Response for Send message (v2) + /// Response for Send message /// public class SendResponse { @@ -642,12 +642,12 @@ protected MqClient() : base() { } public override string ToString() => base.ToString(); /// - /// Delete message (v2) + /// Delete message /// /// Deletes one message from the queue, by doing a destructive get. /// The request body. /// Cancellation token. - /// The Delete message (v2) response. + /// The Delete message response. public virtual async Task DeleteAsync(SingleGetValidOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.DeleteAsync"); @@ -667,12 +667,12 @@ public virtual async Task DeleteAsync(SingleGetValidOptions input, Cancell } /// - /// Delete messages (v2) + /// Delete messages /// /// Deletes messages from the queue, by doing a destructive get. /// The request body. /// Cancellation token. - /// The Delete messages (v2) response. + /// The Delete messages response. public virtual async Task DeleteAllAsync(MultipleGetValidOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.DeleteAllAsync"); @@ -692,12 +692,12 @@ public virtual async Task DeleteAllAsync(MultipleGetValidOptions inpu } /// - /// Browse message (v2) + /// Browse message /// /// Browse one message from the queue. /// The request body. /// Cancellation token. - /// The Browse message (v2) response. + /// The Browse message response. public virtual async Task ReadAsync(SingleGetValidOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.ReadAsync"); @@ -717,12 +717,12 @@ public virtual async Task ReadAsync(SingleGetValidOptions input, Cancellat } /// - /// Browse messages (v2) + /// Browse messages /// /// Browse messages in a queue. /// The request body. /// Cancellation token. - /// The Browse messages (v2) response. + /// The Browse messages response. public virtual async Task ReadAllAsync(MultipleGetValidOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.ReadAllAsync"); @@ -742,12 +742,12 @@ public virtual async Task ReadAllAsync(MultipleGetValidOptions input, } /// - /// Receive message (v2) + /// Receive message /// /// Returns one message from the queue, by doing a destructive get. /// The request body. /// Cancellation token. - /// The Receive message (v2) response. + /// The Receive message response. public virtual async Task ReceiveAsync(SingleGetValidOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.ReceiveAsync"); @@ -767,12 +767,12 @@ public virtual async Task ReceiveAsync(SingleGetValidOptions input, Cancel } /// - /// Receive messages (v2) + /// Receive messages /// /// Returns messages from the queue, by doing a destructive get. /// The request body. /// Cancellation token. - /// The Receive messages (v2) response. + /// The Receive messages response. public virtual async Task ReceiveAllAsync(MultipleGetValidOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.ReceiveAllAsync"); @@ -792,12 +792,12 @@ public virtual async Task ReceiveAllAsync(MultipleGetValidOptions inp } /// - /// Send message (v2) + /// Send message /// /// Send a message to a queue. /// The request body. /// Cancellation token. - /// The Send message (v2) response. + /// The Send message response. public virtual async Task SendAsync(SendValidDataOptions input, CancellationToken cancellationToken = default) { using var activity = MqClient.ConnectorActivitySource.StartActivity("MqClient.SendAsync"); diff --git a/src/Azure.Connectors.Sdk/Generated/SqlExtensions.cs b/src/Azure.Connectors.Sdk/Generated/SqlExtensions.cs index e923326..2bf5da5 100644 --- a/src/Azure.Connectors.Sdk/Generated/SqlExtensions.cs +++ b/src/Azure.Connectors.Sdk/Generated/SqlExtensions.cs @@ -30,7 +30,7 @@ namespace Azure.Connectors.Sdk.Sql.Models #region Types /// - /// Response for Execute a SQL query (V2) + /// Response for Execute a SQL query /// [DynamicSchema("GetPassThroughNativeQueryMetadata_V2")] public class ExecutePassThroughNativeQueryResponse @@ -44,7 +44,7 @@ public class ExecutePassThroughNativeQueryResponse } /// - /// Execute stored procedure (V2) + /// Execute stored procedure /// [DynamicSchema("GetProcedure_V2")] public class ExecuteProcedureInput @@ -58,7 +58,7 @@ public class ExecuteProcedureInput } /// - /// Response for Execute stored procedure (V2) + /// Response for Execute stored procedure /// [DynamicSchema("GetProcedure_V2")] public class ExecuteProcedureResponse @@ -72,7 +72,7 @@ public class ExecuteProcedureResponse } /// - /// Response for Get row (V2) + /// Response for Get row /// [DynamicSchema("GetTable_V2")] public class GetItemResponse @@ -221,7 +221,7 @@ public class Table } /// - /// Update row (V2) + /// Update row /// [DynamicSchema("GetTableForPatch_V2")] public class PatchItemInput @@ -235,7 +235,7 @@ public class PatchItemInput } /// - /// Response for Update row (V2) + /// Response for Update row /// [DynamicSchema("GetTable_V2")] public class PatchItemResponse @@ -249,7 +249,7 @@ public class PatchItemResponse } /// - /// Insert row (V2) + /// Insert row /// [DynamicSchema("GetTable_V2")] public class PostItemInput @@ -263,7 +263,7 @@ public class PostItemInput } /// - /// Response for Insert row (V2) + /// Response for Insert row /// [DynamicSchema("GetTable_V2")] public class PostItemResponse @@ -1034,13 +1034,13 @@ namespace Azure.Connectors.Sdk.Sql public static class SqlTriggerOperations { /// - /// When an item is created (V2). + /// When an item is created. /// Payload type: . /// public const string OnNewItems = "GetOnNewItems_V2"; /// - /// When an item is modified (V2). + /// When an item is modified. /// Payload type: . /// public const string OnUpdatedItems = "GetOnUpdatedItems_V2"; @@ -1229,7 +1229,7 @@ protected SqlClient() : base() { } public override string ToString() => base.ToString(); /// - /// Delete row (V2) + /// Delete row /// /// This operation deletes a row from a table. /// Server name @@ -1264,14 +1264,14 @@ await this } /// - /// Execute a SQL query (V2) + /// Execute a SQL query /// - /// Execute a SQL query (V2) + /// Execute a SQL query /// Server name /// Database name /// The request body. /// Cancellation token. - /// The Execute a SQL query (V2) response. + /// The Execute a SQL query response. public virtual async Task ExecutePassThroughNativeQueryAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, SqlPassThroughNativeQueryBody input, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.ExecutePassThroughNativeQueryAsync"); @@ -1295,7 +1295,7 @@ public virtual async Task ExecutePassThro } /// - /// Execute stored procedure (V2) + /// Execute stored procedure /// /// This operation runs a stored procedure. /// Server name @@ -1303,7 +1303,7 @@ public virtual async Task ExecutePassThro /// Procedure name /// The request body. /// Cancellation token. - /// The Execute stored procedure (V2) response. + /// The Execute stored procedure response. public virtual async Task ExecuteProcedureAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, [DynamicValues("GetProcedures_V2")] string procedureName, ExecuteProcedureInput input, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.ExecuteProcedureAsync"); @@ -1329,7 +1329,7 @@ public virtual async Task ExecuteProcedureAsync([Dynam } /// - /// Get row (V2) + /// Get row /// /// This operation gets a row from a table. /// Server name @@ -1337,7 +1337,7 @@ public virtual async Task ExecuteProcedureAsync([Dynam /// Table name /// Row id /// Cancellation token. - /// The Get row (V2) response. + /// The Get row response. public virtual async Task GetItemAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, [DynamicValues("GetTablesForGetItem_V2")] string tableName, string rowId, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.GetItemAsync"); @@ -1365,7 +1365,7 @@ public virtual async Task GetItemAsync([DynamicValues("GetServe } /// - /// Get rows (V2) + /// Get rows /// /// This operation gets rows from a table. /// Server name @@ -1381,7 +1381,7 @@ public virtual async Task GetItemAsync([DynamicValues("GetServe /// Extract MIP Labels /// Purview Account Name /// Cancellation token. - /// The Get rows (V2) response. + /// The Get rows response. public virtual async Task GetItemsAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, [DynamicValues("GetTables_V2")] string tableName, string aggregationTransformation = default, string filterQuery = default, string orderBy = default, int? skipCount = default, int? topCount = default, string selectQuery = default, bool? count = default, bool? extractMIPLabels = default, string purviewAccountName = default, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.GetItemsAsync"); @@ -1426,7 +1426,7 @@ public virtual async Task GetItemsAsync([DynamicValues("GetSer } /// - /// Get tables (V2) + /// Get tables /// /// This operation gets tables from a database. /// Server name @@ -1434,7 +1434,7 @@ public virtual async Task GetItemsAsync([DynamicValues("GetSer /// Extract MIP Labels /// Purview Account Name /// Cancellation token. - /// The Get tables (V2) response. + /// The Get tables response. public virtual async Task GetTablesAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, bool? extractMIPLabels = default, string purviewAccountName = default, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.GetTablesAsync"); @@ -1463,7 +1463,7 @@ public virtual async Task GetTablesAsync([DynamicValues("GetS } /// - /// Update row (V2) + /// Update row /// /// This operation updates an existing row in a table. /// Server name @@ -1472,7 +1472,7 @@ public virtual async Task GetTablesAsync([DynamicValues("GetS /// Row id /// The request body. /// Cancellation token. - /// The Update row (V2) response. + /// The Update row response. public virtual async Task PatchItemAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, [DynamicValues("GetTablesForPatchItem_V2")] string tableName, string rowId, PatchItemInput input, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.PatchItemAsync"); @@ -1500,7 +1500,7 @@ public virtual async Task PatchItemAsync([DynamicValues("GetS } /// - /// Insert row (V2) + /// Insert row /// /// This operation inserts a new row into a table. /// Server name @@ -1508,7 +1508,7 @@ public virtual async Task PatchItemAsync([DynamicValues("GetS /// Table name /// The request body. /// Cancellation token. - /// The Insert row (V2) response. + /// The Insert row response. public virtual async Task PostItemAsync([DynamicValues("GetServers")] string serverName, [DynamicValues("GetDatabases")] string databaseName, [DynamicValues("GetTablesForPostItem_V2")] string tableName, PostItemInput input, CancellationToken cancellationToken = default) { using var activity = SqlClient.ConnectorActivitySource.StartActivity("SqlClient.PostItemAsync");