Add explicit instructions for reversing complex versioning patterns#4499
Open
Copilot wants to merge 4 commits into
Open
Add explicit instructions for reversing complex versioning patterns#4499Copilot wants to merge 4 commits into
Copilot wants to merge 4 commits into
Conversation
Add examples for reversing: - @madeRequired decorator in stable-after-preview and preview-after-preview - @returnTypeChangedFrom in preview-after-preview - Property default value changes using @removed/@added/@renamedFrom pattern - Sync-to-async operation template conversions using @removed/@added/@renamedFrom pattern Each reversal includes both ARM and data-plane examples where applicable. Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
…rence Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add explicit instructions for reversing complex patterns in versioning
Add explicit instructions for reversing complex versioning patterns
May 26, 2026
markcowl
approved these changes
May 27, 2026
| - oldLevel: int32; | ||
| - | ||
| - @added(Versions.`2026-01-01-preview`) | ||
| - @encodedName("application/json", "level") |
Member
There was a problem hiding this comment.
Suggested change
| - @encodedName("application/json", "level") |
| + changedProp: string; | ||
| ``` | ||
|
|
||
| ```diff lang=tsp |
Member
There was a problem hiding this comment.
Remove this example altogether. @returnTypeChangedFrom is only usable for simple operations
Collaborator
|
No changes needing a change description found. |
Collaborator
|
You can try these changes here
|
…per review - Remove @returnTypeChangedFrom reversal example (only usable for simple operations) - Remove @Encodedname decorator from default value reversal examples Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Contributor
Author
Done in commit 7f5f6b3. Removed the |
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.
The versioning how-to docs lacked explicit instructions for reversing complex patterns (e.g., changes introduced in a preview that need to be reverted in a succeeding version).
Changes
03-stable-after-preview.mdand02-preview-after-preview.md— added reversal instructions and examples for:@madeRequireddecorator reversal@removed/@added/@renamedFrompattern@removed/@added/@renamedFrompattern (ARM + data-plane)Each complex pattern includes a cross-reference to the "Adding Decoration to an Existing Type" section in
06-evolving-apis.md.Example: Reversing a sync-to-async operation template change
@armResourceOperations interface Employees { - @removed(Versions.`2025-12-01-preview`) - @renamedFrom(Versions.`2025-12-01-preview`, "createOrUpdate") - @sharedRoute - createOrUpdateV1 is ArmResourceCreateOrReplaceSync<Employee>; - - @added(Versions.`2025-12-01-preview`) - @sharedRoute - createOrUpdate is ArmResourceCreateOrReplaceAsync<Employee>; + createOrUpdate is ArmResourceCreateOrReplaceSync<Employee>; }