eng, add management-breaking-changes-mitigation.md#49531
Draft
weidongxu-microsoft wants to merge 1 commit into
Draft
eng, add management-breaking-changes-mitigation.md#49531weidongxu-microsoft wants to merge 1 commit into
weidongxu-microsoft wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new documentation page under docs/ to help reviewers classify and mitigate breaking changes in Azure Java management-plane SDKs, particularly those encountered during Swagger → TypeSpec migrations.
Changes:
- Added a mitigation guide that maps common Revapi/changelog breaking-change patterns to likely TypeSpec/generator causes.
- Documented recommended mitigation approaches via TypeSpec customization (
client.tsp) and generator configuration (tspconfig.yaml). - Included concrete examples for common break categories (manager naming, client/type renames, accessor renames, type-shape changes, etc.).
Comment on lines
+5
to
+8
| For Java management libraries, the main mitigation surfaces are: | ||
|
|
||
| 1. `client.tsp` for Java-specific client customizations such as `@@clientName`, `@@clientLocation`, and `@@alternateType` | ||
| 2. `tspconfig.yaml` for generator options under `@azure-tools/typespec-java` |
| @@clientName(Microsoft.Example.Assessment, "AssessmentResource", "java"); | ||
| ``` | ||
|
|
||
| If the model is not present, inspect `back-compatible.tsp` for an existing `@@clientName` that maps to this name, and add a Java-specific override in `client.tsp`. |
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.
fix Azure/azure-sdk-tools#15562
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines