Azure
diff --git a/‎.devcontainer/Dockerfile
Lines changed: 21 additions & 0 deletions b/‎.devcontainer/Dockerfile
Lines changed: 21 additions & 0 deletions
diff --git a/‎.devcontainer/devcontainer.json
Lines changed: 12 additions & 0 deletions b/‎.devcontainer/devcontainer.json
Lines changed: 12 additions & 0 deletions
diff --git a/‎.gitattributes
Lines changed: 2 additions & 2 deletions b/‎.gitattributes
Lines changed: 2 additions & 2 deletions
diff --git a/‎.github/PULL_REQUEST_TEMPLATE/ARM_spec_pr_review_workflow_diagram.png
283 KB b/‎.github/PULL_REQUEST_TEMPLATE/ARM_spec_pr_review_workflow_diagram.png
283 KB
diff --git a/‎.github/PULL_REQUEST_TEMPLATE/control_plane_template.md
Lines changed: 49 additions & 13 deletions b/‎.github/PULL_REQUEST_TEMPLATE/control_plane_template.md
Lines changed: 49 additions & 13 deletions
diff --git a/‎.github/PULL_REQUEST_TEMPLATE/data_plane_template.md
Lines changed: 15 additions & 0 deletions b/‎.github/PULL_REQUEST_TEMPLATE/data_plane_template.md
Lines changed: 15 additions & 0 deletions
diff --git a/‎.github/comment.yml
Lines changed: 11 additions & 91 deletions b/‎.github/comment.yml
Lines changed: 11 additions & 91 deletions
@@ -0,0 +1,21 @@
+FROM mcr.microsoft.com/mirror/docker/library/ubuntu:22.04
+
+RUN apt-get -y update &&  apt upgrade -y && apt install curl -y
+RUN apt-get -y install git
+
+# install node and npm
+RUN curl -sL https://deb.nodesource.com/setup_16.x | bash -
+RUN apt -y install nodejs
+RUN npm install -g [email protected]
+
+# install oav tool
+RUN npm install -g oav@latest
+
+# install powershell
+RUN apt-get update && apt-get install -y wget
+RUN wget -q https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
+RUN dpkg -i packages-microsoft-prod.deb
+RUN apt-get update
+RUN apt-get install -y powershell
+
+ENTRYPOINT ["/bin/bash"]
@@ -0,0 +1,12 @@
+{
+  "name": "TypeSpec Dev Container",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  "remoteUser": "root"
+  /*,
+  update below source folder to your local sdk-repos folder
+  "mounts": [
+    "source=/home/rc/repos/tmp/sdk-repos,target=/workspaces/sdk-repos,type=bind,consistency=cached"
+  ]*/
+}
@@ -1,2 +1,2 @@
-# Set the default behavior, in case people don't have core.autocrlf set.
-* text=auto
+# Use unix line endings always, even on Windows
+* text=auto eol=lf
@@ -1,5 +1,21 @@
 # ARM (Control Plane) API Specification Update Pull Request 
 
+## PR review workflow diagram
+
+Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
+
+![diagram](https://github.com/Azure/azure-rest-api-specs/assets/4429827/b321e1dc-5e07-4940-9cd6-a65ac6729a8b)
+
+[1] [ARM review queue] (for **merge** queues, see [4])  
+The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. 
+If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label `ARMChangesRequested` 
+is removed from your PR. This should cause the label `WaitForARMFeedback` to be added.  
+[2] https://aka.ms/azsdk/support/specreview-channel  
+[3] [List of SDK breaking changes approvers] in pinned Teams announcement  
+[4] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1])
+
+If you need further help with anything, see `Getting help` section below.
+
 ## Purpose of this PR
 
 What's the purpose of this PR? Check all that apply. This is **mandatory**!
@@ -15,27 +31,47 @@ What's the purpose of this PR? Check all that apply. This is **mandatory**!
 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 have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
-- [ ] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
-- [ ] I commit to follow the [Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy).
+- [ ] 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](https://aka.ms/rpguidelines), including
   [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and
   [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md) (estimated time: 4 hours).  
-  I understand this is required before I can request review from an ARM API Review board.
+  I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
+
+### Breaking changes review (Step 1)
 
-### ARM API changes review
+- If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
+  you must follow the [breaking changes process].  
+  **IMPORTANT** This applies even if:
+  - The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
+  - You believe there is no need for you to request breaking change approval, for any reason. 
+    Such claims must be reviewed, and the process is the same.
 
-- If you want for the ARM team to review this PR, you must add the `ARMReview` label. 
-- The automation may automatically add the `ARMReview` label, if appropriate.  
-  If this happens, proceed according to guidance given in GitHub comments also added by the automation.
+### ARM API changes review (Step 2)
 
-### Breaking change review
+- If this PR is in purview of ARM review then automation will add the `ARMReview` label.
+- If you want to force ARM review, add the label yourself.
+- Proceed according to the diagram at the top of this comment.
+
+## 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](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) 
+to get approval.
 
-If you have any breaking changes as defined in the [Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy/), 
-follow the process outlined in the [High-level Breaking Change Process doc](https://aka.ms/breakingchangesprocess#high-level-breaking-change-process).
-      
 ## Getting help
 
+- For general PR approval workflow, see the diagram at the top of this comment.
 - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure 
   and https://aka.ms/ci-fix.
-- For additional help, see https://aka.ms/azsdk/support/spectools.
+- 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.
+
+[ARM review queue]: https://github.com/search?q=org%3AAzure+is%3Apr+is%3Aopen+label%3AWaitForARMFeedback+-label%3AIDCDevDiv++draft%3Afalse+sort%3Acreated-asc+&type=pullrequests
+[List of SDK breaking changes approvers]: https://teams.microsoft.com/l/message/19:[email protected]/1689115217750?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1689115217750&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1689115217750
+[public repo merge queue]: https://github.com/Azure/azure-rest-api-specs/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+draft%3Afalse+sort%3Acreated-asc
+[private repo merge queue]: https://github.com/Azure/azure-rest-api-specs-pr/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+-label%3AApproved-OkToMerge+draft%3Afalse+sort%3Acreated-asc
+[breaking changes process]: https://eng.ms/docs/cloud-ai-platform/azure-core/azure-core-pm-and-design/trusted-platform-pm-karimb/service-lifecycle-and-actions-team/service-lifecycle-actions-team/apex/media/launchingproductbreakingchanges#breaking-change-process-1
@@ -13,11 +13,23 @@ Is this review for (select one):
 - [ ] GA release
 
 ### Change Scope
+
 <sup>This section will help us focus on the specific parts of your API that are new or have been modified. <br/>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. </sup>
 * 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](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) 
+to get approval.
+
 ## ❔Got questions? Need additional info?? We are here to help!
 
 <details>
@@ -33,16 +45,19 @@ The [Azure API Review Board](https://aka.ms/azsdk/onboarding/restapischedule) is
   <summary>Click here for links to tools, specs, guidelines & other good stuff</summary>
 
 ### Tooling
+
  * [Open API validation tools](https://aka.ms/swaggertools) were run on this PR. Go here to see [how to fix errors](https://aka.ms/ci-fix)
  * [Spectral Linting](https://aka.ms/style)
  * [Open API Hub](https://aka.ms/openapiportal)
 
 ### Guidelines & Specifications
+
  * [Azure REST API Guidelines](https://aka.ms/guidelines)
  * [OpenAPI Style Guidelines](https://aka.ms/style)
  * [Azure Breaking Change Policy](https://aka.ms/AzBreakingChangesPolicy)
 
 ### Helpful Links
+
  * [Azure DevTools Wiki](https://aka.ms/azapi)
 
 </details>
@@ -1,61 +1,4 @@
 ---
-- rule:
-    type: label
-    label: BreakingChangeReviewRequired
-    booleanFilterExpression: "!(Approved-OkToMerge)"
-    onLabeledComments: >-
-      Hi @${PRAuthor}! The automation detected breaking changes in this pull request.
-      As a result, it added the `BreakingChangeReviewRequired` label.
-      <br/><br/>
-      You cannot proceed with merging this PR until you complete one of the following action items:
-      <br/><br/>
-      **ACTION ITEM ALTERNATIVE A**: Fix the breaking change. <br/>
-      Please consult the documentation provided in the relevant validation failures.
-      <br/><br/>
-      **ACTION ITEM ALTERNATIVE B**: Request approval. <br/>
-      Alternatively, if you cannot fix the breaking changes, then you can request an approval for them.
-      Please follow the process described in the
-      [High-level Breaking Change Process doc](https://aka.ms/breakingchangesprocess#high-level-breaking-change-process).
-      <br/><br/>
-      **ACTION ITEM ALTERNATIVE C**: Report false positive. <br/>
-      If you think there are no breaking changes, 
-      i.e. the validation should pass yet it fails, 
-      then please explain why in a PR comment and @ the PR assignee.
-
-- rule:
-    type: label
-    label: NewApiVersionRequired
-    booleanFilterExpression: "!(Approved-OkToMerge)"
-    onLabeledComments: >-
-      Hi @${PRAuthor}! The automation detected this pull request introduces changes
-      to at least one existing API version that violate Azure's versioning policy. 
-      To comply with the policy, these changes must be made in a new API version.
-      As a result, the automation added the `NewApiVersionRequired` label.
-      <br/><br/> 
-      You cannot proceed with merging this PR until you complete one of the following action items:
-      <br/><br/>
-      **ACTION ITEM ALTERNATIVE A**: Introduce a new API version. <br/> 
-      Submit a new PR instead of this one, or modify this PR, 
-      so that it adds a new API version instead of introducing changes to existing API versions.
-      <br/><br/>
-      **ACTION ITEM ALTERNATIVE B**: Request approval. <br/>
-      Alternatively, if you cannot avoid modifying existing API versions, 
-      then you can request an approval for them.
-      Please follow the process described in the
-      [High-level Breaking Change Process doc](https://aka.ms/breakingchangesprocess#high-level-breaking-change-process).
-      <br/><br/>
-      **ACTION ITEM ALTERNATIVE C**: Report false positive. <br/>
-      If you think there are no changes in existing API version, 
-      i.e. there should be no `NewApiVersionRequired` label,
-      then please explain why in a PR comment and @ the PR assignee.
-      <br/><br/>   
-      For additional guidance, please see https://aka.ms/NewApiVersionRequired
-
-- rule:
-    type: label
-    label: SuppressionReviewRequired
-    onLabeledComments: "Hi @${PRAuthor}, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the [Swagger-Suppression-Process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) to get approval."
-
 - rule:
     type: label
     label: "CI-MissingBaseCommit"
@@ -76,11 +19,14 @@
     label: Approved-OkToMerge
     onLabeledComments: >-
       Hi @${PRAuthor}! Your PR is approved. Congratulations. :partying_face::rocket: </br>
-      <li>If this PR is targeting 'main' branch, then it cannot be merged, as azure-rest-api-specs-pr repo 'main' branch is mirrored from azure-rest-api-specs 'main' branch.
-      If you want to publish the PR to the public repo (Azure/azure-rest-api-specs) 'main' branch, 
+      <li>
+      If this PR is targeting `main` branch, then it cannot be merged, as `azure-rest-api-specs-pr` repo `main` branch 
+      is mirrored from `azure-rest-api-specs` `main`` branch. <br/>
+      If you want to publish the PR to the public repo (`Azure/azure-rest-api-specs`) `main` branch, 
       please use [OpenAPIHub Publish PR](${openapiHub}/tools/publishpullrequest?pr=${owner}/${repo}/${PRNumber}&to=${to}).
-      </li> 
-      <li>For further guidance on how to proceed please refer to this [wiki doc](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**).
+      </li><li>
+      For further guidance on how to proceed please refer to this 
+      [wiki article](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**).
       </li>
 
 - rule:
@@ -98,36 +44,11 @@
     label: ArcReview
     onLabeledComments: "Hi @${PRAuthor} and @arcboard, one or more change(s) have been detected in your Arc enabled VM's or Arc enabled Server's RPs. Please review the changes and ensure that no gaps have been introduced with respect to the ARM API modeling consistency across Azure Arc and Azure Compute. For further details, see guidelines at [Consistency in ARM Modeling](https://msazure.visualstudio.com/One/_wiki/wikis/One.wiki/377428/Consistency-in-ARM-Modeling?anchor=general-design-guidance). To approve the change(s), set the label to ArcSignedOff. If you have any questions, please mail to [email protected]."
 
-- rule:
-    type: label
-    label: CI-FixRequiredOnFailure
-    onLabeledComments: >- 
-      Hi @${PRAuthor}! Your PR has some issues. Please fix the CI issues, **if present**, in following order: `Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff`.
-      <br/>
-      <table><tr><th>Task</th><th>How to fix</th><th>Priority</th></tr>
-      <tr><td>Avocado</td><td>[Fix-Avocado](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#avocado)</td><td>High</td></tr>
-      <tr><td>Semantic Validation</td><td>[Fix-SemanticValidation-Error](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#semantic-validation)</td><td>High</td></tr>
-      <tr><td>Model Validation</td><td>[Fix-ModelValidation-Error](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#model-validation)</td><td>High</td></tr>
-      <tr><td>LintDiff</td><td>[Fix-LintDiff](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#lintdiff-validation)</td><td>High</td></tr></table>
-      <br/>
-      If you need further help, please reach out on the Teams channel [aka.ms/azsdk/support/specreview-channel](https://aka.ms/azsdk/support/specreview-channel).
-
 - rule:
     type: label
     label: new-rp-namespace
     onLabeledComments: "Hi, @${PRAuthor}, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. </br> <b>Action Required</b>: <li> Follow this guidance [Naming for new initial management or client libraries (new SDKs) - Overview (azure.com)](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/821/Naming-for-new-initial-management-or-client-libraries-(new-SDKs)) to create an issue for management client library name arch board review. </li> <li>Paste the issue link that you created in step 1 in this PR</li> </br> <b> Impact</b>: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed."
 
-- rule:
-    type: PROpen
-    variables:
-      openapiHub: https://aka.ms/openapihub
-    onOpenedComments: >- 
-      Hi, @${PRAuthor}! Thank you for your pull request. To help get your PR merged:</br>
-      - Ensure you reviewed the checklists in the PR description.
-      - Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
-      - 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.
-
 - rule:
     type: checkbox
     keywords:
@@ -160,13 +81,12 @@
     type: label
     label: ARMChangesRequested
     onLabeledComments: >-
-      Please address or respond to feedback from the ARM API reviewer.
-      When you are ready to continue the ARM API review, please remove the `ARMChangesRequested` label.
+      Please address or respond to feedback from the ARM API reviewer. <br/>
+      When you are ready to continue the ARM API review, please remove the `ARMChangesRequested` label. <br/>
       This will notify the reviewer to have another look. <br/>
       If the feedback provided needs further discussion, please use this Teams channel to post your questions - 
-      https://aka.ms/azsdk/support/specreview-channel. <br/>
-      Please indicate that this is an ARM-related question in the title of your post by including "[ARM Query]"
-      in the title.
+      [aka.ms/azsdk/support/specreview-channel](https://aka.ms/azsdk/support/specreview-channel). <br/>
+      Please include `[ARM Query]` in the title of your question to indicate that it is ARM-related.
     onLabeledRemoveLabels:
         - WaitForARMFeedback