Skip to content

Regenerate Sql, AzureAD and Mq with documentation version affixes aligned - #228

Open
daviburg wants to merge 1 commit into
mainfrom
fix/regen-summary-version-affix-demo
Open

Regenerate Sql, AzureAD and Mq with documentation version affixes aligned#228
daviburg wants to merge 1 commit into
mainfrom
fix/regen-summary-version-affix-demo

Conversation

@daviburg

@daviburg daviburg commented Jul 31, 2026

Copy link
Copy Markdown
Member

Description

Regenerates Sql, AzureAD and Mq from AzureUX-BPM PR 16648499, which aligns generated documentation with the identifiers it documents.

Version affixes are stripped from identifiers but survived in the human-readable text derived from the swagger summary and description, so SqlExtensions emitted public class GetTablesResponse documented as Response for Get tables (V2) — the identifier and its own documentation disagreed.

Documentation-comment only. All 94 changed lines are doc comments. No identifier, signature or wire change.

Demonstrating set

These three clients were chosen to exercise all three behaviours of the fix, not to be exhaustive:

Client Affixed doc lines Demonstrates
Sql 28 → 2 The motivating example
Mq 17 → 0 Lowercase (v2), matched case-insensitively
AzureAD 5 → 1 Both the strip and the keep case

AzureAD is the interesting one. Four affixes are dropped because the identifier was simplified. The one that remains documents GetMemberGroupsResponseV2, which kept its affix — so its summary has to keep it too, or it reads identically to its sibling and callers cannot tell the two response types apart. That is the case that rules out simply stripping every affix.

Sql was originally held out of this PR: regenerating it also pulled in the Purview identifier correction that was in flight as #227, which would have put the same change in two open PRs. #227 has since merged, so Sql now regenerates clean and is included.

Catalogue-wide the generator fix takes 384 affixed doc lines down to 45 across shipped clients; the remaining 45 are all deliberate (28 verbatim trigger citations, 15 mid-sentence, 2 identifiers that kept their affix). The other affected clients settle in the planned full sweep rather than inflating this PR.

Testing

  • Unit tests added/updated

  • All existing tests pass (dotnet test)

  • Manual testing (describe below if applicable)

  • dotnet build: 0 errors, 0 warnings.

  • 935 tests pass, 0 failures.

  • Generated from the BPM branch at commit 7201f4d039 with --directClient --connectors=sql,azuread,mq against the pinned 1596-entry ARM cache.

  • Verified mechanically that every changed line is a doc comment, so this cannot alter behaviour.

  • Rebased onto main at 6f75cd4 after Regenerate Sql and AzureBlob with the corrected Purview parameter name #227 merged.

No unit tests added: this PR contains only generated output. The generator behaviour is covered by 8 new tests in the paired BPM PR, verified non-vacuous by neutralizing the match pattern.

Checklist

  • Code follows the project's coding conventions
  • No modifications to files under src/**/Generated/ (see CONTRIBUTING.md)
  • Documentation updated (if behavior changed)
  • CHANGELOG.md updated (if user-facing change)
  • release_notes.md updated (if shipping a new version, clear previous version notes)
  • Version updated in eng/build/Version.props (if shipping a new version)

The Generated/ checkbox is intentionally left unchecked: this is a generator-driven regeneration, the sanctioned way those files change. No file was hand-edited.

CHANGELOG.md is intentionally not updated — this changes documentation comments only, with no effect on the compiled API surface or on callers.

Depends on AzureUX-BPM PR 16648499 merging first.

Authored with Dobby agent.

Copilot AI review requested due to automatic review settings July 31, 2026 18:43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.

@daviburg daviburg self-assigned this Jul 31, 2026
…gned

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 <dobby@microsoft.com>
@daviburg
daviburg force-pushed the fix/regen-summary-version-affix-demo branch from a8cd2a3 to a6f55a4 Compare July 31, 2026 20:46
Copilot AI review requested due to automatic review settings July 31, 2026 20:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.

@daviburg daviburg changed the title Regenerate AzureAD and Mq with documentation version affixes aligned Regenerate Sql, AzureAD and Mq with documentation version affixes aligned Jul 31, 2026
@daviburg
daviburg marked this pull request as ready for review July 31, 2026 21:03
@daviburg
daviburg requested a review from a team as a code owner July 31, 2026 21:03
@daviburg
daviburg enabled auto-merge (squash) July 31, 2026 21:03
@daviburg

Copy link
Copy Markdown
Member Author

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants