Skip to content

AVS SDKs generated directly from TypeSpec #34346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

cataggar
Copy link
Member

@cataggar cataggar commented Apr 29, 2025

This is a followup to

It configured the AVS SDKs to be generated directly form TypeSpec instead of from Swagger (OpenAPI).

SDK configuration pull request

Purpose of this PR

  • Make changes to the SDK configuration only when there are no modifications to the API specification, eliminating the need for an ARM or Stewardship Board API review.

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Getting help

  • First, carefully read through this PR description, from top to bottom. Fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Apr 29, 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).
  • ❌ 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

Copy link

openapi-pipeline-app bot commented Apr 29, 2025

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

Copy link

github-actions bot commented May 1, 2025

API Change Check

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

Language API Review for Package
java com.azure.resourcemanager:azure-resourcemanager-avs
JavaScript @azure/arm-avs
TypeSpec Microsoft.AVS
Go sdk/resourcemanager/avs/armavs
go sdk/resourcemanager/avs/armavs

@JiaqiZhang-Dev
Copy link
Member

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@cataggar
Copy link
Member Author

cataggar commented May 6, 2025

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@cataggar cataggar marked this pull request as ready for review May 8, 2025 17:46
@cataggar
Copy link
Member Author

cataggar commented May 8, 2025

I'm not sure if this related issue is a blocker for this PR or not:

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 8, 2025
@github-actions github-actions bot added ARMAutoSignedOff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels May 8, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 8, 2025
@cataggar
Copy link
Member Author

cataggar commented May 9, 2025

Thanks @kazrael2119 for the JavaScript SDK fixes. I'd like to get this merged. I understand the individual SDKs may have some additional adjustments that they can do during follow-ups to achieve SDK compatibility. BreakingChange-Go-Sdk-Approved is needed to merge. cc @JiaqiZhang-Dev

@tadelesh
Copy link
Member

@cataggar most Go breaking changes come from the singleton resource route problem that weidong mentioned in the team's channel discussion. we are discussing how to resolve it.

@cataggar
Copy link
Member Author

Waiting on a new version of typespec-azure with this fix:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMAutoSignedOff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Go-Sdk BreakingChange-JavaScript-Sdk BreakingChange-JavaScript-Sdk-Approved ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants