docs: add versioning guidance for spread-in properties using augment decorators - #5324
Draft
Mark Cowlishaw (markcowl) with Copilot wants to merge 3 commits into
Draft
docs: add versioning guidance for spread-in properties using augment decorators#5324Mark Cowlishaw (markcowl) with Copilot wants to merge 3 commits into
Mark Cowlishaw (markcowl) with Copilot wants to merge 3 commits into
Conversation
|
Azure Pipelines: 1 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
…decorators Closes #4809 Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation for version-scoping a spread model property with @@added
docs: add versioning guidance for spread-in properties using augment decorators
Aug 26, 2026
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 docs cover
@added/@removedon inline-declared properties but not on properties introduced via model spreads (...SomeModel), which have no inline declaration site for decorators. This gap causes authors to either leave spread properties unscoped (breaking the API surface of earlier versions) or attempt workarounds that don't compile.Adds a new subsection under "Complex Scenarios" in the Evolving APIs versioning doc covering:
@added/@removed; the@@augment form must be used instead@@addedexample — scoping aManagedServiceIdentityPropertyspread to a specific version@@removedexample — removing a spread-in property in a later version@@madeOptional,@@madeRequired,@@renamedFrom,@@typeChangedFrom