Skip to content

Conversation

v-hongli1
Copy link
Member

This PR migrates your latest version (identified by the tag in your readme.md) of swagger to TypeSpec. We already tried our best to make sure the TypeSpec represents same as previous swagger. Since we lack the business knowledge, please validate this PR again to make sure it's functional equivalent as before. The local validation step is at Getting started | TypeSpec Azure

Besides, TypeSpec encourages to follow ARM guidelines. Therefore, some representations in your previous swagger will be fixed to follow these guidelines. When you see differences in your local validation, please keep this note in mind. Here is the list you need to pay attention:

Please reach out to TypeSpec Discussions Channel if there is any help needed.

Copy link

github-actions bot commented Sep 11, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.


Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added resource-manager TypeSpec Authored with TypeSpec BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Sep 11, 2025
Copy link

github-actions bot commented Sep 11, 2025

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger Microsoft.Network
TypeSpec Microsoft.Network
Go sdk/resourcemanager/trafficmanager/armtrafficmanager
JavaScript @azure/arm-trafficmanager

@v-hongli1 v-hongli1 force-pushed the convert-trafficmanager-20250911 branch from 209c4d4 to ec27915 Compare September 11, 2025 07:42
@v-hongli1 v-hongli1 force-pushed the convert-trafficmanager-20250911 branch from 05f4a4b to ffa4f81 Compare September 11, 2025 07:52
@v-hongli1 v-hongli1 force-pushed the convert-trafficmanager-20250911 branch from d574a16 to 2e08069 Compare September 12, 2025 03:29
@v-hongli1
Copy link
Member Author

v-hongli1 commented Sep 24, 2025

@pshao25
The commit#c8d02e6 and commit#d3c0f2e are try to add the ResourceNameParameter to the model. You can view the results in CI. I recommend not adding the ResourceNameParameter to avoid Swagger ModelValidation exceptions.

@pshao25
Copy link
Member

pshao25 commented Sep 25, 2025

@pshao25 The commit#c8d02e6 and commit#d3c0f2e are try to add the ResourceNameParameter to the model. You can view the results in CI. I recommend not adding the ResourceNameParameter to avoid Swagger ModelValidation exceptions.

Don't recommend anything before you get into the root cause of the pipeline failures. In your case, the pipeline failed because its original resource's type property is not readonly, while if we extend from the resource from our library, it is readonly.

@github-actions github-actions bot removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 26, 2025
@github-actions github-actions bot added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 26, 2025
@v-hongli1 v-hongli1 force-pushed the convert-trafficmanager-20250911 branch from a44d33a to 48d5ac9 Compare September 28, 2025 07:45
@v-hongli1 v-hongli1 force-pushed the convert-trafficmanager-20250911 branch 2 times, most recently from 6e48e4d to 2ac729e Compare September 28, 2025 09:24
@github-actions github-actions bot removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 29, 2025
@v-hongli1 v-hongli1 force-pushed the convert-trafficmanager-20250911 branch from a68d2d9 to 2ac729e Compare September 29, 2025 06:52
@github-actions github-actions bot added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants