Skip to content

[TSP Migration] Migrate healthbot from swagger to TypeSpec#34069

Merged
pshao25 merged 63 commits intoAzure:mainfrom
welovej:TspMig-healthbot
Oct 29, 2025
Merged

[TSP Migration] Migrate healthbot from swagger to TypeSpec#34069
pshao25 merged 63 commits intoAzure:mainfrom
welovej:TspMig-healthbot

Conversation

@welovej
Copy link
Copy Markdown
Member

@welovej welovej commented Apr 21, 2025

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 of your anti-pattern:

  • Your resource definition is not referring the resource definitions from common-type.

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

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Apr 21, 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 is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
    Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ This PR is NotReadyForARMReview because it has the BreakingChangeReviewRequired label.
  • ❌ 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 Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app bot commented Apr 21, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 21, 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.HealthBot
TypeSpec Microsoft.HealthBot
Go sdk/resourcemanager/healthbot/armhealthbot
Python azure-mgmt-healthbot
Java com.azure.resourcemanager:azure-resourcemanager-healthbot
JavaScript @azure/arm-healthbot

@pshao25 pshao25 marked this pull request as draft April 21, 2025 10:44
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Oct 13, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Oct 27, 2025
@guy-microsoft
Copy link
Copy Markdown
Contributor

In review in Canary env.

Copy link
Copy Markdown
Contributor

@guy-microsoft guy-microsoft left a comment

Choose a reason for hiding this comment

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

Approved by service team.

},
"description": "Array of Azure Health Bot Secrets.",
"minLength": 3,
"maxLength": 3
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@welovej @pshao25 I see that this was removed as part of the migration to TypeSpec. Is it not supported anymore?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure we really want minLength maxLength here, but just to understand why it was omitted.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

minLength and maxLength are used to restrict string length. I think it's wrong usage before, so omitted.

@josefree
Copy link
Copy Markdown
Member

The updates in the PR has passed API Validation as RPaaS required. I labelled the PR with "canary-validation-pass".
image

Removed unused dependency annotations for API version.
@pshao25 pshao25 added BreakingChange-JavaScript-Sdk-Approved Approved-LintDiff BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. labels Oct 29, 2025
@github-actions github-actions bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Oct 29, 2025
@pshao25 pshao25 added PublishToCustomers Acknowledgement the changes will be published to Azure customers. ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Oct 29, 2025
@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 29, 2025
@pshao25 pshao25 merged commit d014311 into Azure:main Oct 29, 2025
83 of 86 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChange-Go-Sdk BreakingChange-Go-Sdk-Approved BreakingChange-JavaScript-Sdk BreakingChange-JavaScript-Sdk-Approved BreakingChange-Python-Sdk BreakingChange-Python-Sdk-Approved BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required canary-validation-pass PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager RPaaS rpaas-tsp-conversion TypeSpec Authored with TypeSpec typespec-conversion-w1

Projects

None yet

Development

Successfully merging this pull request may close these issues.