[AutoPR @azure-arm-chaos]-generated-from-SDK Generation - JS-6258085#38436
[AutoPR @azure-arm-chaos]-generated-from-SDK Generation - JS-6258085#38436azure-sdk wants to merge 3 commits into
Conversation
…/Chaos/tspconfig.yaml', API Version: 2026-05-01-preview, SDK Release Type: beta, and CommitSHA: '84d40416fbb3d2416cb7abe7ec82e63c76832963' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6258085 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
github-actions
Bot
added
the
Mgmt
Update api-version in test recordings from 2025-01-01 to 2026-05-01-preview for all Chaos API calls to match the new SDK version. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
RenzoPrettoMS
force-pushed
the
sdkauto/@azure-arm-chaos-6258085
branch
from
982fd0b to
3af962d
Compare
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
RenzoPrettoMS
requested review from
a team,
JialinHuang803,
MaryGao,
jeremymeng,
qiaozha and
xirzec
as code owners
kazrael2119
added
Self-Service Release
github-actions
Bot
added
mgmt-review-in-progress
Next Steps to MergeOnly failed checks and required actions are listed below. All CI checks have passed. However, there is one blocking design concern that requires resolution before merging:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 design concern found: the stable API version V20250101 (2025-01-01) has been removed from KnownVersions. Per Azure SDK guidelines, stable API versions must not be removed. All CI checks passed.
📊 Structured Report
{"agent":"mgmt-reviewer","pr":38436,"summary":"issues_found","findings":[{"file":"sdk/chaos/arm-chaos/review/arm-chaos-node.api.md","line":743,"issueType":"design","category":"breaking_change","description":"Stable API version V20250101 (2025-01-01) removed from KnownVersions enum"}]}⚡ Benchmarked by Management Release Assistant
| @@ -458,15 +741,33 @@ export enum KnownTargetReferenceType { | |||
|
|
|||
| // @public | |||
| export enum KnownVersions { | |||
There was a problem hiding this comment.
🔴 Design Concern — arm-chaos-node.api.md:743
KnownVersions no longer includes V20250101 = "2025-01-01", which was a stable GA API version present in the previous release (2.0.0).
Per Azure SDK guidelines, stable API versions must not be removed from KnownVersions, as this constitutes a breaking change for customers who depend on explicit version pinning.
Fix: Discuss with the service team whether the stable 2025-01-01 API version should be retained. If it must be dropped, this requires explicit sign-off. Consider adding it back in the TypeSpec spec and triggering SDK regeneration, or discuss migration guidance on the spec side.
There was a problem hiding this comment.
this is because the new version 2026-05-01-preview is added in middle location of enum Versions
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/main.tsp#L47-L61
When we specify a version, tcgc does not give us the enum below this version as a potential value, so 2025-01-01 is lost, and 2025-01-01 has released which introduced the breaking
@RenzoPrettoMS could you help to update this code to
enum Versions {
/**
* The 2024-11-01-preview API version.
*/
v2024_11_01_preview: "2024-11-01-preview",
/**
* The 2025-01-01 API version.
*/
v2025_01_01: "2025-01-01",
/**
* The 2026-05-01-preview API version.
*/
v2026_05_01_preview: "2026-05-01-preview",
}
to resolve this breaking?
after the change merged into main, re-trigger the generation will fix the breaking
There was a problem hiding this comment.
Please refer to https://azure.github.io/typespec-azure/docs/howtos/versioning/01-about-versioning/#preview-versioning-rules-for-all-azure-apis
Preview Versioning Rules for All Azure APIs
- Always make the last enum value the preview and apply @previewVersion to it.
- Only one version may be marked with the @previewVersion decorator.
- Mark all changes from the latest stable with appropriate versioning decorators, using Versions. as the version argument (where is the name of the last enum value)
According to [Azure preview versioning policy](https://learn.microsoft.com/en-us/azure/developer/intro/azure-service-sdk-tool-versioning#preview-versions. And https://azure.github.io/typespec-azure/docs/howtos/versioning/01-about-versioning/#preview-versioning-rules-for-all-azure-apis):
Previews aren't intended for long-term use. Anytime a new stable or preview version of a service becomes available, existing preview versions can become unavailable as early as 90 days from the availability of the new version.
There was a problem hiding this comment.
|
Regenerated with the fix #38530 |
4 participants
Configurations: 'specification/chaos/resource-manager/Microsoft.Chaos/Chaos/tspconfig.yaml', API Version: 2026-05-01-preview, SDK Release Type: beta, and CommitSHA: '84d40416fbb3d2416cb7abe7ec82e63c76832963' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6258085 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. Release plan link: https://apps.powerapps.com/apps/821ab569-ae60-420d-8264-d7b5d5ef734c?release-plan-id=cdbef413-5829-f111-8341-000d3a597585 Submitted by: renzopretto@microsoft.com
Release Plan Details
Spec pull request: Add Chaos Studio 2026-05-01-preview API version azure-rest-api-specs#41486
Spec API version: 2026-05-01-preview