Adding 2024-08-01 For Microsoft ToolchainOrchestrator From Private Spec Repo #30930

FireDefend · 2024-10-09T09:25:42Z

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.

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.

openapi-pipeline-app · 2024-10-09T09:25:46Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This is the public specs repo main branch which is not intended for iterative development.
You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
If this is what you intend, add PublishToCustomers label to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR has ARMChangesRequested label. 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.
Automation should then add WaitForARMFeedback label.
❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review
❌ The required check named SDK azure-sdk-for-go has failed. 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 3 in the PR workflow diagram

openapi-pipeline-app · 2024-10-09T09:25:47Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-resourcemanager-toolchainorchestrator	https://apiview.dev/Assemblies/Review/7a64ab4876074e83b7f463e8d1bcf058?revisionId=5c958198fd5140518b322ef0ae2de553
JavaScript	@azure/arm-toolchainorchestrator	https://apiview.dev/Assemblies/Review/b9ce9bcfdd904d15aac01782d2183fc0?revisionId=f48d48bca0954cb784f18703fe08c2a3
TypeSpec	Symphony.Management	https://apiview.dev/Assemblies/Review/190f93d465dd4ab0bece5fcd146a3279?revisionId=ecf9d8c3603a41ef8f982c7e51083f90
Swagger	Microsoft.ToolchainOrchestrator	https://apiview.dev/Assemblies/Review/8cbbbf06e9464d06990e30e0afec0a39?revisionId=7a87a5e015174f0f8ddcd767c2ff7af9

FireDefend · 2024-10-09T09:28:55Z

Merge 08-01 version from private spec repo

Referring PR:
https://github.com/Azure/azure-rest-api-specs-pr/pull/19114

mentat9 · 2024-10-16T22:08:31Z

Merge 08-01 version from private spec repo

Referring PR: Azure/azure-rest-api-specs-pr#19114

Please fill out the intake form at the top.

The PR you linked that merged to the private is significantly different from this PR. Did you link the wrong PR from the
private repo? If not, then this PR requires full re-review because it's not possible to correlate the APIs between the two.

FireDefend · 2024-10-17T02:47:32Z

Merge 08-01 version from private spec repo
Referring PR: Azure/azure-rest-api-specs-pr#19114

Please fill out the intake form at the top.

The PR you linked that merged to the private is significantly different from this PR. Did you link the wrong PR from the private repo? If not, then this PR requires full re-review because it's not possible to correlate the APIs between the two.

I have filled the intake. Thanks for reminding.

Here is the detail. I only pick up the content under "specification/symphony/resource-manager/Microsoft.ToolchainOrchestrator/preview/2024-08-01-preview/" from the private repo. We only have two versions "2024-04-01-preview" and "2024-08-01-preview". "2024-04-01-preview" is for private preview and "2024-08-01-preview" is for public preview.

It looks like we shouldn't checkin the private preview version to the public, right? And the Typespec code also contains both of "2024-04-01-preview" and "2024-08-01-preview".

So I may need some advises from ARM team, do we need to check in all the files under "specification/symphony/" ? Or we need to hide the private preview version?

…FireDefend/azure-rest-api-specs into users/xigsun/updatesymphony1009

FireDefend · 2024-10-17T06:26:48Z

added typespec part, waiting for reviews from arm team

ramoka178 · 2024-10-21T20:15:54Z

Merge 08-01 version from private spec repo
Referring PR: Azure/azure-rest-api-specs-pr#19114

Please fill out the intake form at the top.
The PR you linked that merged to the private is significantly different from this PR. Did you link the wrong PR from the private repo? If not, then this PR requires full re-review because it's not possible to correlate the APIs between the two.

I have filled the intake. Thanks for reminding.

Here is the detail. I only pick up the content under "specification/symphony/resource-manager/Microsoft.ToolchainOrchestrator/preview/2024-08-01-preview/" from the private repo. We only have two versions "2024-04-01-preview" and "2024-08-01-preview". "2024-04-01-preview" is for private preview and "2024-08-01-preview" is for public preview.

It looks like we shouldn't checkin the private preview version to the public, right? And the Typespec code also contains both of "2024-04-01-preview" and "2024-08-01-preview".

So I may need some advises from ARM team, do we need to check in all the files under "specification/symphony/" ? Or we need to hide the private preview version?

I think it might be ok to just have 2024-04-01-preview in this repo

ramoka178 · 2024-10-21T20:18:24Z

Please fix the Swagger LintDiff errors in this PR. Looks like the use case is approved already in the private repo. Please add suppressions as needed in readme.

…FireDefend/azure-rest-api-specs into users/xigsun/updatesymphony1009

FireDefend · 2024-10-22T06:50:36Z

Please fix the Swagger LintDiff errors in this PR. Looks like the use case is approved already in the private repo. Please add suppressions as needed in readme.

I have checked in with both "2024-04-01-preview" and "2024-08-01-preview" now.

For Swagger LintDiff errors, according to PRs in private repo, can you please add "Approved-LintDiff" tag to bypass?

ramoka178 · 2024-10-22T18:49:14Z

The jsons match to what is existing. We should be good there.
@FireDefend Could you add suppressions in the readme file for the lintdiffs. It would be easier to review those for any next set of iterations, instead of always pointing to an older PR that got the approved label. If we are relying on previous PRs, since the LintDiff errors are many , we might miss if there are any new ones popping up in a future APIs.

…FireDefend/azure-rest-api-specs into users/xigsun/updatesymphony1009

FireDefend · 2024-10-24T03:21:56Z

suppressions added

ramoka178 · 2024-10-24T18:04:09Z

specification/symphony/resource-manager/readme.md

@@ -37,6 +37,10 @@ These settings apply only when `--tag=package-2024-08-01-preview` is specified o
 ```yaml $(tag) == 'package-2024-08-01-preview'
 input-file:
  - Microsoft.ToolchainOrchestrator/preview/2024-08-01-preview/toolchainOrchestrator.json
+suppressions:
+  - code: AvoidAdditionalProperties


Please add specific paths instead of ignoring for whole file.

ramoka178 · 2024-10-24T18:04:12Z

specification/symphony/resource-manager/readme.md

@@ -46,4 +50,8 @@ These settings apply only when `--tag=package-2024-04-01-preview` is specified o
 ```yaml $(tag) == 'package-2024-04-01-preview'
 input-file:
  - Microsoft.ToolchainOrchestrator/preview/2024-04-01-preview/toolchainOrchestrator.json
+suppressions:
+  - code: AvoidAdditionalProperties


Please add specific paths instead of ignoring for whole file.

ramoka178 · 2024-10-24T18:04:27Z

specification/symphony/resource-manager/readme.md

@@ -54,4 +57,7 @@ suppressions:
  - code: AvoidAdditionalProperties
    from: toolchainOrchestrator.json
    reason: Service design forces behavior
+  - code: EnumInsteadOfBoolean


Please add specific paths instead of ignoring for whole file.

ramoka178 · 2024-10-24T18:04:31Z

specification/symphony/resource-manager/readme.md

@@ -41,6 +41,9 @@ suppressions:
  - code: AvoidAdditionalProperties
    from: toolchainOrchestrator.json
    reason: Service design forces behavior
+  - code: EnumInsteadOfBoolean


Please add specific paths instead of ignoring for whole file.

ramoka178 · 2024-10-24T18:04:53Z

Please fix Swagger Avocado errors too

microsoft-github-policy-service · 2024-11-11T00:47:24Z

Hi, @FireDefend. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

microsoft-github-policy-service · 2024-11-25T14:05:23Z

Hi, @FireDefend. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

check 08-01 toolchain api

fa3e89d

AzureRestAPISpecReview added ARMReview new-api-version new-rp-namespace resource-manager RPaaS TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 9, 2024

FireDefend enabled auto-merge (squash) October 10, 2024 07:54

FireDefend disabled auto-merge October 16, 2024 07:18

Merge branch 'main' into users/xigsun/updatesymphony1009

a586c83

NetStorm-E added 2 commits October 17, 2024 14:17

checkin typespec

85b2bfb

Merge branch 'users/xigsun/updatesymphony1009' of https://github.com/…

45aa6b8

…FireDefend/azure-rest-api-specs into users/xigsun/updatesymphony1009

update java config

189baea

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 21, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 21, 2024

NetStorm-E added 2 commits October 22, 2024 14:40

add 2024-04-01-preview

81006b6

Merge branch 'users/xigsun/updatesymphony1009' of https://github.com/…

e01b217

…FireDefend/azure-rest-api-specs into users/xigsun/updatesymphony1009

Merge branch 'main' into users/xigsun/updatesymphony1009

22cbd1f

FireDefend removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 22, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 22, 2024

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 22, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 22, 2024

FireDefend and others added 3 commits October 23, 2024 08:55

Merge branch 'main' into users/xigsun/updatesymphony1009

c849a8f

add supression for AvoidAdditionalProperties

d0d8e8c

Merge branch 'users/xigsun/updatesymphony1009' of https://github.com/…

b2c5360

…FireDefend/azure-rest-api-specs into users/xigsun/updatesymphony1009

AzureRestAPISpecReview added the SuppressionReviewRequired label Oct 23, 2024

NetStorm-E and others added 2 commits October 24, 2024 11:15

ignore EnumInsteadOfBoolean

b9fa877

Merge branch 'main' into users/xigsun/updatesymphony1009

62e18df

FireDefend removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 24, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 24, 2024

ramoka178 reviewed Oct 24, 2024

View reviewed changes

ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 24, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 24, 2024

live1206 mentioned this pull request Oct 30, 2024

Sample generation failures Azure/autorest.csharp#5132

Closed

microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Nov 11, 2024

microsoft-github-policy-service bot closed this Nov 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding 2024-08-01 For Microsoft ToolchainOrchestrator From Private Spec Repo #30930

Adding 2024-08-01 For Microsoft ToolchainOrchestrator From Private Spec Repo #30930

FireDefend commented Oct 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 9, 2024 •

edited

Loading

FireDefend commented Oct 9, 2024

mentat9 commented Oct 16, 2024

FireDefend commented Oct 17, 2024 •

edited

Loading

FireDefend commented Oct 17, 2024 •

edited

Loading

ramoka178 commented Oct 21, 2024

ramoka178 commented Oct 21, 2024

FireDefend commented Oct 22, 2024

ramoka178 commented Oct 22, 2024 •

edited

Loading

FireDefend commented Oct 24, 2024

ramoka178 Oct 24, 2024

ramoka178 Oct 24, 2024

ramoka178 Oct 24, 2024

ramoka178 Oct 24, 2024

ramoka178 commented Oct 24, 2024

microsoft-github-policy-service bot commented Nov 11, 2024

microsoft-github-policy-service bot commented Nov 25, 2024

Adding 2024-08-01 For Microsoft ToolchainOrchestrator From Private Spec Repo #30930

Adding 2024-08-01 For Microsoft ToolchainOrchestrator From Private Spec Repo #30930

Conversation

FireDefend commented Oct 9, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Oct 9, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Oct 9, 2024 • edited Loading

Generated ApiView

FireDefend commented Oct 9, 2024

mentat9 commented Oct 16, 2024

FireDefend commented Oct 17, 2024 • edited Loading

FireDefend commented Oct 17, 2024 • edited Loading

ramoka178 commented Oct 21, 2024

ramoka178 commented Oct 21, 2024

FireDefend commented Oct 22, 2024

ramoka178 commented Oct 22, 2024 • edited Loading

FireDefend commented Oct 24, 2024

ramoka178 Oct 24, 2024

Choose a reason for hiding this comment

ramoka178 Oct 24, 2024

Choose a reason for hiding this comment

ramoka178 Oct 24, 2024

Choose a reason for hiding this comment

ramoka178 Oct 24, 2024

Choose a reason for hiding this comment

ramoka178 commented Oct 24, 2024

microsoft-github-policy-service bot commented Nov 11, 2024

microsoft-github-policy-service bot commented Nov 25, 2024

FireDefend commented Oct 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 9, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 9, 2024 •

edited

Loading

FireDefend commented Oct 17, 2024 •

edited

Loading

FireDefend commented Oct 17, 2024 •

edited

Loading

ramoka178 commented Oct 22, 2024 •

edited

Loading