azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Published 20 hours ago • verified publisher icon Azure

Releasing new stable API version migrating ARE from preview to feature

Open sushil490023 opened this issue 1 year ago • 2 comments

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.

sushil490023 avatar Oct 23 '24 06:10 sushil490023

Next Steps to Merge

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

openapi-pipeline-app[bot] avatar Oct 23 '24 06:10 openapi-pipeline-app[bot]

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/automation/armautomation https://apiview.dev/Assemblies/Review/0c7b4a9e6b4b4de9b750ccf18148dd7e?revisionId=d3889ac9ac08444085631914d6f8f01f
JavaScript @azure/arm-automation https://apiview.dev/Assemblies/Review/96f003ba012746828eb56c3795863cc4?revisionId=5edefbe19f33469cab5fc2dcfad30da7
.Net Azure.ResourceManager.Automation https://apiview.dev/Assemblies/Review/9d50d66e07f14a03a180b372996221f3?revisionId=aac65c3ff7ed4dd7b6647f2e53a8efea
Python azure-mgmt-automation https://apiview.dev/Assemblies/Review/639b5975c16946718f82440dbab6a5a2?revisionId=4c127626dc4a474480a309de6aacd97c

openapi-pipeline-app[bot] avatar Oct 23 '24 06:10 openapi-pipeline-app[bot]

Breaking changes previously reviewed and approved in #23988

mikekistler avatar Nov 01 '24 13:11 mikekistler

/azp run

sushil490023 avatar Nov 05 '24 09:11 sushil490023

Commenter does not have sufficient privileges for PR 31168 in repo Azure/azure-rest-api-specs

azure-pipelines[bot] avatar Nov 05 '24 09:11 azure-pipelines[bot]

/azp run

raosuhas avatar Nov 08 '24 00:11 raosuhas

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines[bot] avatar Nov 08 '24 00:11 azure-pipelines[bot]

Can you please update the description checkboxes ?

For this PR you need to follow the instructions there https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-specs?tabs=openapi to add a base commit with the previous api version.

raosuhas avatar Nov 08 '24 00:11 raosuhas

Hi @raosuhas

Thanks for reviewing

I have updated the PR description checkboxes.

In the first commit, I simply copied the preview API Swagger version 2023-05-15-preview to a stable API version 2024-10-23. The file in this version contains no changes except for the updated API version. Subsequent commits include the required changes.

I also have a few questions regarding the test failures in the PR:

Avocado Errors The Avocado tests are failing for the default API version. However, the new API versions do not include dscCompilationJob.json and powershell72Module.json APIs.

Swagger LintDiff Failure Most validation errors in Swagger LintDiff are related to older Swagger versions, not the new one.

Additionally, could you please:

  1. Add the IDC tag to this PR?
  2. Grant permission to run the tests by commenting /azp run. Thanks!

sushil490023 avatar Nov 14 '24 05:11 sushil490023

/azp run

ms-bogdan-rotaru avatar Nov 18 '24 08:11 ms-bogdan-rotaru

Azure Pipelines successfully started running 3 pipeline(s).

azure-pipelines[bot] avatar Nov 18 '24 08:11 azure-pipelines[bot]

@sushil490023 Can you please provide an explanation for the errors reported by the Swagger LintDiff check and how were these resolved in the preview API Swagger version?

ms-bogdan-rotaru avatar Nov 18 '24 10:11 ms-bogdan-rotaru

@ms-bogdan-rotaru These errors were previously not coming for when it was merged during preview API version

sushil490023 avatar Nov 25 '24 05:11 sushil490023

@sushil490023 please address the LintDiff error or if you have valid reasons to continue with these errors then take a look at the suppression guide here

venu-sivanadham avatar Nov 29 '24 11:11 venu-sivanadham

API change check

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

Microsoft.Automation

azure-sdk avatar Dec 02 '24 03:12 azure-sdk

Hi @venu-sivanadham ,

For Lint diff erros

  1. ProvisioningStateValidation errors are flagged for ProvisioningState must have terminal states: Succeeded, Failed and Canceled. its coming as previous api version are having Cancelled instead of Canceled , this cannot be changed as been already being used.
  2. AvoidAdditionalProperties errors are flagged with error Definitions must not have properties named additionalProperties except for user defined tags or predefined references. . This is being used in production currently and being consumed

I have added suppression rules as suggested

sushil490023 avatar Dec 02 '24 03:12 sushil490023 

reason: This error format is inherited from previous api, cannot change it as it will result in inconsistency.

I have couple of observations that's not aligning with this justification.

  • The package.json swagger file in this same api-version has 'Canceled' enum.
  • In previous stable version (2023-11-01) the enum is defined as 'Canceled' but you are changing it to 'Cancelled' for this stable version.

Also, you can join ARM office hours for the suppression review.

Refers to: specification/automation/resource-manager/readme.md:678 in 82b0b81. [](commit_id = 82b0b810eaeefca73a528e6c8395030710deeba1, deletion_comment = False)

venu-sivanadham avatar Dec 02 '24 05:12 venu-sivanadham 

reason: This error format is inherited from previous api, cannot change it as it will result in inconsistency.

I have couple of observations that's not aligning with this justification.

  • The package.json swagger file in this same api-version has 'Canceled' enum.
  • In previous stable version (2023-11-01) the enum is defined as 'Canceled' but you are changing it to 'Cancelled' for this stable version.

Also, you can join ARM office hours for the suppression review.

Refers to: specification/automation/resource-manager/readme.md:678 in 82b0b81. [](commit_id = 82b0b81, deletion_comment = False)

Hi @sushil490023 -- Looks like this is pending a supression review ? Pl attend the IDC office hours for the same: https://outlook.office365.com/book/[email protected]/s/DbvLwCX1IUqeyGw6ziXDOQ2?login_hint

viveksheelsingh avatar Dec 03 '24 11:12 viveksheelsingh