[AutoPR @azure-contoso-widgetmanager]-generated-from-SDK Generation - JS-6049814#37781
[AutoPR @azure-contoso-widgetmanager]-generated-from-SDK Generation - JS-6049814#37781azure-sdk wants to merge 1 commit into
Conversation
…ager/tspconfig.yaml', API Version: 2026-03-01-preview, SDK Release Type: beta, and CommitSHA: 'eabb54a20ec2e6214f756d805261dfc3312ebea8' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6049814 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
There was a problem hiding this comment.
This PR adds the new package @azure/contoso-widgetmanager (v1.0.0-beta.1, API version 2022-12-01). The review found 2 issues: 1 tool issue (missing CHANGELOG.md) and 1 design concern (an OperationState_2 naming collision in the public API surface caused by a duplicate name between the locally exported string union type and the OperationState imported from @azure/core-lro). No other naming, type-safety, version-alignment, or export issues were identified. CI check is in progress.
📊 Structured Report
{"agent":"mgmt-reviewer","pr":37781,"summary":"issues_found","findings":[{"file":"sdk/contosowidgetmanager/contoso-widgetmanager/package.json","line":3,"issueType":"tool","category":"missing-file","description":"CHANGELOG.md is missing from the new package; the generation tool should create it automatically."},{"file":"sdk/contosowidgetmanager/contoso-widgetmanager/review/contoso-widgetmanager-node.api.md","line":34,"issueType":"design","category":"naming","description":"Locally exported OperationState type collides with OperationState from `@azure/core-lro`, causing API Extractor to expose OperationState_2 in public method signatures (lines 102-103, 57)."}]}⚡ Benchmarked by Management SDK PR Review
| @@ -0,0 +1,169 @@ | |||
| { | |||
| "name": "@azure/contoso-widgetmanager", | |||
| "version": "1.0.0-beta.1", | |||
There was a problem hiding this comment.
🔴 Tool Issue — package.json (missing CHANGELOG.md)
The new package @azure/contoso-widgetmanager does not include a CHANGELOG.md file. All SDK packages require a CHANGELOG.md, and the generation tool should produce one automatically for new packages (with a hard-coded first entry).
Fix: Check the generation tool configuration and report the missing CHANGELOG.md generation to the generation tool repository. Then manually add a CHANGELOG.md with the initial 1.0.0-beta.1 entry as a workaround.
| } | ||
|
|
||
| // @public | ||
| export type OperationState = "NotStarted" | "Running" | "Succeeded" | "Failed" | "Canceled"; |
There was a problem hiding this comment.
🔴 Design Concern — review/contoso-widgetmanager-node.api.md:34 (OperationState naming collision)
export type OperationState = "NotStarted" | "Running" | "Succeeded" | "Failed" | "Canceled";The locally exported OperationState string union type collides with OperationState imported from @azure/core-lro. API Extractor resolves the conflict by renaming the import to OperationState_2, which then appears in the public method return types:
// lines 102–103
createOrUpdateWidget: (...) => PollerLike(OperationState_2(WidgetSuite), WidgetSuite);
deleteWidget: (...) => PollerLike(OperationState_2(WidgetSuite), WidgetSuite);This exposes a confusing _2-suffixed name in the public API surface, violating the _N suffix naming guideline.
Fix: Rename the locally exported OperationState string union type in the TypeSpec spec (e.g., use @clientName("WidgetOperationState") or another non-colliding name), then trigger SDK regeneration.
|
Hi @azure-sdk. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |
|
Hi @azure-sdk. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing |
Configurations: 'specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml', API Version: 2026-03-01-preview, SDK Release Type: beta, and CommitSHA: 'eabb54a20ec2e6214f756d805261dfc3312ebea8' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6049814 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.