Simplify generated operation and type names (breaking change)#44
Merged
Conversation
Regenerated all 4 connector files with simplified names: - Strip version suffixes (V2, V3, V4) from methods, triggers, types - Normalize triggers to start with On prefix - Apply per-connector overrides for natural English names - Drop OnFlaggedEmailV3 (V4 supersedes, identical parameters) - Rename type aliases (ClientSendHtmlMessage -> SendEmailInput) Wire values (operationId strings) remain unchanged. Closes #43
daviburg
force-pushed
the
feature/simplify-names
branch
from
5c63c64 to
637c696
Compare
There was a problem hiding this comment.
Pull request overview
This PR regenerates the SDK’s generated connector clients (Office365, Teams, SharePoint Online, Kusto) to simplify operation/type/trigger names (e.g., stripping V2/V3 suffixes from method names) while keeping wire operationId values unchanged. It updates unit tests and constants to match the new public API surface, explicitly introducing a breaking change for consumers.
Changes:
- Regenerated connector extension files with simplified method/type/trigger names while preserving operationId string values.
- Updated tests to use the new names and adjusted trigger registries/counts (e.g., removing the flagged-email V3 trigger).
- Updated
CHANGELOG.mdrelease links/entries and tweaked markdownlint configuration.
Reviewed changes
Copilot reviewed 4 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/Microsoft.Azure.Connectors.Sdk.Tests/Office365TriggerPayloadTests.cs | Updates trigger payload type names and trigger registry assertions for Office365. |
| tests/Microsoft.Azure.Connectors.Sdk.Tests/Office365ClientTests.cs | Updates Office365 client test to renamed GetEmailAsync. |
| tests/Microsoft.Azure.Connectors.Sdk.Tests/KustoClientTests.cs | Updates Kusto client tests to renamed ListKustoResultsAsync. |
| tests/Microsoft.Azure.Connectors.Sdk.Tests/ConnectorConstantsTests.cs | Updates trigger operation constant names/values to new public names. |
| src/Microsoft.Azure.Connectors.Sdk/Generated/TeamsExtensions.cs | Regenerated Teams types/trigger constants/parameter classes with simplified names. |
| src/Microsoft.Azure.Connectors.Sdk/Generated/SharepointonlineExtensions.cs | Regenerated SharePoint Online trigger payload/type aliases and renamed ExtractFolderAsync. |
| src/Microsoft.Azure.Connectors.Sdk/Generated/Office365Extensions.cs | Regenerated Office365 client methods, DTO aliases, and trigger constants/metadata. |
| src/Microsoft.Azure.Connectors.Sdk/Generated/KustoExtensions.cs | Renamed Kusto methods to remove Post suffix. |
| CHANGELOG.md | Adds a 0.2.0-preview.1 entry and updates compare/release links. |
| .markdownlint.json | Adjusts MD024 configuration (siblings_only). |
The SampleConnectorUsage project only printed usage patterns via Console.WriteLine without compiling against the generated types, so it didn't catch breaking changes. The dedicated Azure/Connectors-NET-Samples repo has real, working samples.
…ithout response types) Adds OnWebhookMessageReactionTrigger, OnWebhookKeywordTrigger, OnWebhookAtMentionTrigger, OnWebhookChatMessageTrigger, OnWebhookNewMessageTrigger to TeamsTriggerOperations.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Regenerated all 4 connector files with simplified names from the updated CodefulSdkGenerator. This is a breaking change for consumers.
Changes
Methods (version suffixes stripped)
Triggers (normalized to start with On, natural English)
Types (per-connector aliases)
Unreferenced definition types pruned (intentional)
The generator now only emits swagger definition types that are transitively reachable from operations. Previously it emitted ALL swagger definitions, including orphaned types never referenced by any operation. This is an intentional breaking change that removes unused types from the public API surface.
Affected connectors:
These types were never used by any generated client method — they existed only because the swagger
definitionssection included them. Consumers who happened to reference them directly will need to remove those references.Two types remain despite being unused at the C# level (EmailAddressV2, ContactResponseV2) because they are transitively reachable via chains in the swagger. Deeper pruning is tracked in #45.
Wire values unchanged
All operationId strings remain the same (e.g.,
public const string OnNewEmail = "OnNewEmailV3").Redundant inline sample removed
Removed
samples/SampleConnectorUsage/— it only printed usage patterns via Console.WriteLine without compiling against the generated types. The dedicated Azure/Connectors-NET-Samples repo has real, working samples.Validation
Closes #43