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

Merging new apiversion 2023-05-01-preview Changes to main #30870

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

Conversation

Bharam-Msft
Copy link
Member

@Bharam-Msft Bharam-Msft commented Oct 6, 2024

Merging new apiversion 2023-05-01-preview Changes to main

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.

Merging new apiversion 2023-05-01-preview Changes to main
Copy link

openapi-pipeline-app bot commented Oct 6, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The suppressions added to the AutoRest config files (README.mds) require review. Refer to step 1 in the PR workflow diagram, or to step 3, depending on the kind of suppression you did.
  • ❌ 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 Oct 6, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/connectedcache/armconnectedcache https://apiview.dev/Assemblies/Review/475d61f32a4e4236b3ff3ffa1105edc2?revisionId=ae59094ec4f547618de2c9db180261d4
Swagger Microsoft.ConnectedCache https://apiview.dev/Assemblies/Review/c193e39454f04a65819821e70619a467?revisionId=6056c4a9deb24e1891f24500420bc730

Bharam-Msft and others added 6 commits October 6, 2024 10:20
adding custom word to resolve spellcheck
Fixing LintDiff
fixing schemantic errors
reverting the read-only property in Provisioning State enum as typespec is giving error
Fixing Lint Errors
@Bharam-Msft
Copy link
Member Author

As per API spec review the swagger ModelValidations are known.looking sugestion from apireview team for workaround or fixes.

@Bharam-Msft Bharam-Msft marked this pull request as ready for review October 7, 2024 17:36
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 7, 2024
Bharam-Msft and others added 3 commits October 7, 2024 12:36
Fixing swagger schemantic errors
…5-01-preview_to_main' of https://github.com/Azure/azure-rest-api-specs into Bharam-Microsoft.ConnectedCache-merge_apiversion_2023-05-01-preview_to_main
@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Oct 7, 2024
@Bharam-Msft
Copy link
Member Author

/azp run

Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@raosuhas
Copy link

raosuhas commented Oct 10, 2024

Can you please take a look at the warnings in the lintdiff and fix as appropriate : https://github.com/Azure/azure-rest-api-specs/pull/30870/checks?check_run_id=31199438783

[bharathi] this got fixed after the branch is updated with latest changes.

@raosuhas
Copy link

raosuhas commented Oct 10, 2024

Is this an RPaaS rp and has this PR already been reviewed in the private repo ?

yes this was approved deployed and tested in private repo.

@raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 10, 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 Oct 10, 2024
@Bharam-Msft
Copy link
Member Author

here is the private repro approved changes : https://github.com/Azure/azure-rest-api-specs-pr/pull/19106

This PR is first attempt to move the changes to main branch for next steps.

@Bharam-Msft Bharam-Msft removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 11, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 11, 2024
…ectedCache-merge_apiversion_2023-05-01-preview_to_main
@Bharam-Msft
Copy link
Member Author

Can you please take a look at the warnings in the lintdiff and fix as appropriate : https://github.com/Azure/azure-rest-api-specs/pull/30870/checks?check_run_id=31199438783

[bharathi] this got fixed after the branch is updated with latest changes.

[bharathi] also at this point we are not planning on changing boolean to enum as these need lot of changes in our userrp as it supports multiple flavors . we already considered this for new properties added recently. but will need to keep all old properties as is.

@Bharam-Msft Bharam-Msft reopened this Oct 13, 2024
@mentat9
Copy link
Member

mentat9 commented Oct 16, 2024

@Bharam-Msft - Signing off for ARM, based on the signoff from the private repo. Can you confirm whether the suppressions are still required and remove them if not needed?

@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 16, 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 Oct 16, 2024
@Bharam-Msft
Copy link
Member Author

PublishToCustomers

@Bharam-Msft Bharam-Msft added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 22, 2024
@Bharam-Msft
Copy link
Member Author

@Bharam-Msft - Signing off for ARM, based on the signoff from the private repo. Can you confirm whether the suppressions are still required and remove them if not needed?

i have removed supression link and i see the next comment as suppression added for autorest config. we are working on SDK generation and that the reason we need to be in main to work on generating SDks. our api verison has preview in it, may be for this supression is required?

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 new-api-version new-rp-namespace 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 RPaaS SuppressionReviewRequired TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants