[AutoPR @azure-arm-network]-generated-from-SDK Generation - JS-6065631#37842
[AutoPR @azure-arm-network]-generated-from-SDK Generation - JS-6065631#37842azure-sdk wants to merge 7 commits into
Conversation
…work/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: stable, and CommitSHA: 'a19ce547612341bf0bcd13d73b1cf58b5a9ea7d0' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6065631 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 |
Breaking Change Analysis: @azure/arm-network v37.0.0-beta.1
Type 1: API Version Upgrade -- 0 itemsNo Type 1 breaking changes. API version is the same (2025-05-01). Type 2: TypeSpec / Emitter Migration -- 83 items
Unified Root Cause Table (Discriminator -> Union Alias -> Operation Signatures)
TypeSpec source: Detailed BreakdownRow 1: Discriminator Type Changes (4 items, Pattern 3)
Row 2: Union Type Alias Changes (4 items, Pattern 4)
Row 3: Operation Signature Changes -- Discriminator-caused (5 items, Pattern 1)
Row 4: Operation Signature Changes -- Void Return (14 items, Pattern 1)Old SDK returned header-only wrapper response types (e.g.,
Row 5: Operation Signature Changes -- String Return / Unwrapped (15 items, Pattern 1)Old SDK wrapped LRO result in response types like
Row 6: Removed List/Collection Interfaces (10 items, Pattern 2)
Row 7: Base Resource Interface Removed (1 item, Pattern 5)
Row 8: value Now Required (10 items)
Row 9: Models/Types Not Exported by Emitter (16 items, Pattern 8)Removed Interfaces (4):
Removed Type Aliases (6):
Removed Enums (6):
Note: These unions ARE defined in TypeSpec but the emitter may not export them because they are only referenced by models not reachable from operations (e.g., ConnectionStateSnapshot uses ConnectionState and EvaluationState). Row 10: OptionalParams Interfaces Removed (4 items, Pattern 9)
All were empty interfaces extending Total: 0 (Type 1) + 83 (Type 2) = 83 breaking changes All breaking changes are caused by the TypeSpec/emitter migration. No API version upgrade impact since both old and new SDK target API version 2025-05-01. |
…work/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: stable, and CommitSHA: '1bae4f04fa0234d80f65b580ac33f139fd7c07f3' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6066053 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
There was a problem hiding this comment.
Found 2 issues in this PR (@azure/arm-network 37.0.0, stable):
- Tool issue (1):
package.jsoncontains"apiRefLink"pointing to the preview docs URL (?view=azure-node-preview) despite this being a stable release. This is likely a generation-tool bug and should be fixed and reported upstream. - Design concern (1): The previous stable version
36.0.0was released only ~6 weeks ago (2026-02-11). Frequent major-version bumps within a 6-month window are not recommended — please confirm with the team whether the timing is justified.
No API naming (_N suffix, AutoGenerated, _ prefix), type safety (unknown in public models), or export (ae-forgotten-export) issues were found. Version numbers are consistent across package.json, CHANGELOG.md, and src/api/networkManagementContext.ts (37.0.0). No alpha versions detected.
📊 Structured Report
{"agent":"mgmt-reviewer","pr":37842,"summary":"issues_found","findings":[{"file":"sdk/network/arm-network/package.json","line":193,"issueType":"tool","category":"apiRefLink preview URL for stable release","description":"apiRefLink uses ?view=azure-node-preview but package version is 37.0.0 (stable). Should use ?view=azure-node-latest."},{"file":"sdk/network/arm-network/CHANGELOG.md","line":3,"issueType":"design","category":"frequent major releases","description":"36.0.0 was released 2026-02-11 (~6 weeks ago). Two major releases within 6 months is flagged for discussion."}]}⚡ Benchmarked by Management SDK PR Review
| "azure" | ||
| ], | ||
| "disableDocsMs": true, | ||
| "apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-network?view=azure-node-preview" |
There was a problem hiding this comment.
🔴 Tool Issue — package.json:193
`"apiRefLink": "(learn.microsoft.com/redacted)
This package is being released as a stable version (37.0.0), but the apiRefLink in //sampleConfiguration points to the preview docs URL (?view=azure-node-preview). This suggests a tooling bug in the generation pipeline that generates package.json.
Fix: Change the apiRefLink value to the stable docs URL:
"apiRefLink": "(learn.microsoft.com/redacted)Please also report this issue in the generation tool repository.
There was a problem hiding this comment.
@skywing918 and @kazrael2119 Could you confirm if this is a codegen bug?
There was a problem hiding this comment.
I think we should support this update in changelog-tool as before we run changelog-tool, the package version should always use 1.0.0-beta.1(this is the default value from codegen). We should dynamicly update this link after changelog-tool completes the version calculation
There was a problem hiding this comment.
| @@ -1,5 +1,591 @@ | |||
| # Release History | |||
|
|
|||
| ## 37.0.0 (2026-03-26) | |||
There was a problem hiding this comment.
🔴 Design Concern — CHANGELOG.md:3
## 37.0.0 (2026-03-26)
The previous stable version 36.0.0 was released on 2026-02-11, which is only ~6 weeks ago. This is well within the 6-month window where frequent major-version breakages are flagged. Two consecutive major releases in such a short window can disrupt customers who are still adopting the previous version.
Fix: Please discuss with the service/spec team whether these breaking changes are urgent enough to justify a new major release at this cadence, or whether they could be batched with the next planned release.
There was a problem hiding this comment.
@JialinHuang803 Have we got the PM's approval for this breaking release? Generally it's not recommanded to release two breakings wihtin 6 months.
There was a problem hiding this comment.
We don't plan to release this package now. This PR is generated for breaking change analysis.
…work/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: stable, and CommitSHA: '02f52b1c1332822011ea514b1aba498bf27d7f7b' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6071639 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
…work/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: beta, and CommitSHA: 'aa591176e14ed29f96ebf1e3899e4356df7f13dd' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6084390 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
…work/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: beta, and CommitSHA: 'b684aff3319ffa5784a8b8d19d6af5adf168a4bb' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6085746 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
…network-6065631 # Conflicts: # pnpm-lock.yaml
…work/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: beta, and CommitSHA: 'a83147fe12aece4ded0bd96be212e5242e087cb9' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6086390 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
Features Added Analysis: @azure/arm-network v37.0.0-beta.1All 495 features are TypeSpec/emitter migration artifacts. None represent genuinely new API capabilities -- the API version is the same (2025-05-01).
Row 1: New-style LRO Operations (285 items)TypeSpec emitter generates new primary LRO methods without the Example:
Top method names: Row 2: PropertiesFormat/Properties Interfaces (184 items)Old SDK flattened These 184 interfaces are exported but not referenced by any operation signature or other model in the API surface -- they are unreachable from the type graph. Examples: Row 3: Base Resource Model Types (10 items)
Row 4: Renamed OptionalParams Interfaces (4 items)Paired with the 4 "Removed Interface" entries in breaking changes (Row 10). The operations were renamed from
Row 5: Paging/Polling Utility Types (4 items)
Re-exported from core packages as named interfaces in the package API surface. Row 6: Renamed Type Aliases + Enums (4 items)
Row 7: Other Interfaces (4 items)
Total: 495 features added (all TypeSpec/emitter migration artifacts) |
|
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. |
Configurations: 'specification/network/resource-manager/Microsoft.Network/Network/tspconfig.yaml', API Version: 2025-05-01, SDK Release Type: beta, and CommitSHA: 'a19ce547612341bf0bcd13d73b1cf58b5a9ea7d0' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6065631 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.