Skip to content

Conversation

@markcowl
Copy link
Member

No description provided.

@markcowl markcowl marked this pull request as draft January 21, 2026 02:41
@azure-sdk
Copy link
Collaborator

No changes needing a change description found.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Jan 21, 2026

You can try these changes here

🛝 Playground 🌐 Website

@markcowl markcowl marked this pull request as ready for review January 22, 2026 00:30
Copy link
Member

@haolingdong-msft haolingdong-msft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @markcowl for putting the versioning related documents together in this PR. It is really helpful and I've learnt a lot! left some comments for understanding and clarification purpose. Thank you so much for your guidance!

May I also ask two general questions?

  1. I saw there is also a versioning doc here: https://azure.github.io/typespec-azure/docs/howtos/versioning/preview-version/. Is this for data-plane? (Basically two versioning related documents in the typespec azure website, so I'm just a bit confused)
image 2. Does this PR include information in below two docs about versioning you've shared before? From my understanding, it includes, but just would like to confirm.

Rules for Versioning Decorators.loop
Scenarios for API Evolution.loop

@markcowl
Copy link
Member Author

Thank you @markcowl for putting the versioning related documents together in this PR. It is really helpful and I've learnt a lot! left some comments for understanding and clarification purpose. Thank you so much for your guidance!

May I also ask two general questions?

  1. I saw there is also a versioning doc here: https://azure.github.io/typespec-azure/docs/howtos/versioning/preview-version/. Is this for data-plane? (Basically two versioning related documents in the typespec azure website, so I'm just a bit confused)

image 2. Does this PR include information in below two docs about versioning you've shared before? From my understanding, it includes, but just would like to confirm.
Rules for Versioning Decorators.loop Scenarios for API Evolution.loop

Yeah, one really important thing is that we make this documentation visible for those who need to see it. I think we might rename the existing doc to 'indicate that it is for 'data-plane only' and introduce another doc alongside it that is for arm, with links to the rest of this documentation.

Copy link
Member

@qiaozha qiaozha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't read all of them yet.

Copy link
Member

@qiaozha qiaozha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To summarize the main different opinion, I have here is:

  1. we can have a vlatestPreview enum key for latest preview versions in the Versions enum.
  2. we can change the mechanism of version continuity of all versioning decorators for preview versions to not extend to stable. It can be extended to newer preview but that was because we have move forward the vlatestPreview value in the version enum. But we can keep the version continuity of all versioning decorators for stable versions.

So that if any feature/changes are still in preview, it has to have the according versioning decorators with a vlatestPreview enum member in it. TypeSpec authors can just focus on the changes happened after it gets GA.

@markcowl markcowl enabled auto-merge January 30, 2026 00:14
@markcowl markcowl disabled auto-merge January 30, 2026 00:17
@markcowl markcowl enabled auto-merge January 30, 2026 00:32
@markcowl markcowl added this pull request to the merge queue Jan 30, 2026
Merged via the queue into Azure:main with commit c386015 Jan 30, 2026
26 checks passed
@markcowl markcowl deleted the version-docs branch January 30, 2026 01:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants