Skip to content
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

[DevCenter] [Microsoft.DevCenter] [Dataplane] Add new stable api version 2025-02-01 #32290

Merged
merged 9 commits into from
Feb 13, 2025

Conversation

snehanagendra
Copy link
Member

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • 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.

@snehanagendra snehanagendra requested a review from a team as a code owner January 23, 2025 00:26
@snehanagendra snehanagendra requested review from DominikMe and weidongxu-microsoft and removed request for a team January 23, 2025 00:26
Copy link

openapi-pipeline-app bot commented Jan 23, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@azure-sdk
Copy link
Collaborator

API change check

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

Microsoft.DevCenter

Copy link
Member

@tbyfield tbyfield left a comment

Choose a reason for hiding this comment

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

LGTM

@snehanagendra snehanagendra added the offline-review-requested Service team has requested PR review be conducted offline. label Feb 6, 2025
@mikekistler mikekistler linked an issue Feb 6, 2025 that may be closed by this pull request
Copy link
Member

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

This mostly looks fine but I left one comment on a minor issue I hope we can get cleaned up.

@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Feb 7, 2025

Update the client.tsp to use the stable api-version

@useDependency(APIVersions.v2024_09_01_preview)

Also you may want to include the latest APIs. E.g. captureSnapshot is not in client.tsp
The fine tuning of this file can be done later with the involvement of SDK dev. But it would be helpful to have something first so we can see how SDK becomes, on your stable API.

@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 11, 2025
@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Feb 12, 2025

LGTM

I've got one comment about outdated client.tsp #32290 (comment)
It is not required for the PR merge, but it would help your SDK work, if issue can be found earlier.

@ArberH
Copy link
Contributor

ArberH commented Feb 12, 2025

LGTM

I've got one comment about outdated client.tsp #32290 (comment) It is not required for the PR merge, but it would help your SDK work, if issue can be found earlier.

Someone on our team will begin on the SDK work after this gets merged in. We're going to leave as is for now. Would appreciate a re-approval with our latest pushes. Thanks!

@mikekistler mikekistler added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Feb 13, 2025
Copy link
Member

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@mikekistler mikekistler added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Feb 13, 2025
@ArberH ArberH added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Feb 13, 2025
@ArberH
Copy link
Contributor

ArberH commented Feb 13, 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.

@ArberH
Copy link
Contributor

ArberH commented Feb 13, 2025

/azp run openapi-pipeline-app

Copy link

No pipelines are associated with this pull request.

@nickdepinet
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.

@ArberH ArberH merged commit ad4acf6 into Azure:main Feb 13, 2025
27 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version offline-review-requested Service team has requested PR review be conducted offline. PublishToCustomers Acknowledgement the changes will be published to Azure customers. TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DevCenter - Microsoft Dev Box] API Review
9 participants