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

AGC-v.2025-01-01 #31902

Merged
merged 8 commits into from
Dec 20, 2024
Merged

AGC-v.2025-01-01 #31902

merged 8 commits into from
Dec 20, 2024

Conversation

cdxu-147
Copy link
Member

ARM (Control 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

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please 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.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • 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 Dec 16, 2024

Next Steps to Merge

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

Copy link

openapi-pipeline-app bot commented Dec 16, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/servicenetworking/armservicenetworking There is no API change compared with the previous version
JavaScript @azure/arm-servicenetworking https://apiview.dev/Assemblies/Review/78fd700d950f45129790c97f9171efdc?revisionId=a19d394848f240a89e44b40ef4ea033e
Python azure-mgmt-servicenetworking https://apiview.dev/Assemblies/Review/eaf5055b29fb4fdeb0e50b2f132f6bb2?revisionId=9a06402e1cef4427a6eaa5c6b2a8d317
TypeSpec ServiceNetworking.Management https://apiview.dev/Assemblies/Review/8e192291c45643238e598a06eac03d95?revisionId=6ae7abe9f1a54140b177afff88e5cc24

@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 16, 2024

API change check

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

Microsoft.ServiceNetworking
Microsoft.ServiceNetworking

@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Dec 17, 2024
@rkmanda
Copy link
Member

rkmanda commented Dec 17, 2024

What are the changes here other than changing the API version string?

Copy link
Member

@rkmanda rkmanda left a comment

Choose a reason for hiding this comment

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

:shipit:

@rkmanda rkmanda added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 17, 2024
@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 Dec 17, 2024
@cdxu-147
Copy link
Member Author

What are the changes here other than changing the API version string?

There's no other change, just releasing a stable version same as the preview version

@cdxu-147 cdxu-147 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 17, 2024
@openapi-pipeline-app openapi-pipeline-app bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Dec 17, 2024
@cdxu-147 cdxu-147 added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review PublishToCustomers Acknowledgement the changes will be published to Azure customers. WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Dec 17, 2024
@rkmanda rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 19, 2024
@openapi-pipeline-app openapi-pipeline-app bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Dec 19, 2024
@rkmanda rkmanda removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 19, 2024
@@ -78,7 +90,6 @@ This is not used by Autorest itself.

```yaml $(swagger-to-sdk)
swagger-to-sdk:
- repo: azure-sdk-for-python
Copy link
Member

Choose a reason for hiding this comment

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

Python SDK could be generated from Typespec so there is no need to keep configuration for swagger.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for reviewing @msyyc , can you please also add the BreakingChange-JavaScript-Sdk-Approved label to help us complete this PR? Thanks

Copy link
Member

Choose a reason for hiding this comment

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

Add JS Owner @kazrael2119 for JS SDK review.

Copy link
Member

Choose a reason for hiding this comment

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

@msyyc have we decided to release from typespec for this service?

Copy link
Member

Choose a reason for hiding this comment

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

Python doesn't see any blocker and I don't want pipeline to generate SDK twice from swagger and typespec which is waste of pipeline resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-JavaScript-Sdk-Suppression BreakingChange-JavaScript-Sdk-Suppression-Approved BreakingChange-Python-Sdk BreakingChange-Python-Sdk-Approved new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. 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.

8 participants