Update header and query parameter for source control #29536
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| SourceControls.json | 2024-08-02-preview(f140c31) | 2024-03-01(main) |
| SourceControls.json | 2024-08-02-preview(f140c31) | 2024-02-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The required parameter 'x-ms-github-auxiliary' was added in the new version. New: Microsoft.App/preview/2024-08-02-preview/SourceControls.json#L174:11 |
|
| The required parameter 'x-ms-github-auxiliary' was added in the new version. New: Microsoft.App/preview/2024-08-02-preview/SourceControls.json#L240:11 |
️⚠️LintDiff: 2 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-08 | package-preview-2024-08(f140c31) | package-preview-2024-08(release-app-Microsoft.App-2024-08-02-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.App/preview/2024-08-02-preview/SourceControls.json#L247 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.App/preview/2024-08-02-preview/SourceControls.json#L254 |
The following errors/warnings exist before current PR submission:
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
resource-manager
WaitForARMFeedback
This was referenced Jun 21, 2024
This was referenced Jun 21, 2024
ramoka178
reviewed
Jun 25, 2024
| "description": "Delete workflow.", | ||
| "required": false, | ||
| "type": "boolean" | ||
| }, |
There was a problem hiding this comment.
Please explain on what are these ?
If the API is deleting sourcecontrol resource, why are these needed ?
Can it be a different API to delete workflows ?
There was a problem hiding this comment.
When creating source control resource, we will create a github workflow for customer. When deleting source control, we give customer the option to only delete source control resource or delete source control and created workflow together.
There is no need to delete workflows because it is a backend resource and not exposed to customer directly, which is also the design from day one. Here is to fix swagger mismatch.
There was a problem hiding this comment.
So, are these working APIs today that the customers are using with ignoreWorkflowDeletionFailure and deleteWorkflow query params ?
Delete is supposed to delete only a single resource.
Could you post any approval that these query parameters could be used ?
There was a problem hiding this comment.
In this case, we're deleting single resource (which is the SourceControl proxy resource). The option to delete the GH workflow file is just a consolidated option for convenience for the user to cleanup any leftover files.
There was a problem hiding this comment.
[ARMBlockingComment] If GH work flow is implicitly created on a source control creation, the deletion of source control resource should also result in deleting GH workflow . There should not be an extra query param for user to pass to clean up GH workflow.
Please schedule a slot in ARM API Review office hours that happens every day to discuss further on this.
https://eng.ms/docs/products/arm/introduction/office_hours
There was a problem hiding this comment.
Did you get a review for this matter?
ramoka178
reviewed
Jun 25, 2024
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json
Show resolved
Hide resolved
ramoka178
reviewed
Jun 25, 2024
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json
Show resolved
Hide resolved
ramoka178
reviewed
Jun 25, 2024
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json
Outdated
Show resolved
Hide resolved
ramoka178
reviewed
Jun 25, 2024
specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json
Show resolved
Hide resolved
ramoka178
added
the
ARMChangesRequested
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
7 tasks
Juliehzl
added
WaitForARMFeedback
ramoka178
added
the
ARMChangesRequested
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
Juliehzl
added
WaitForARMFeedback
ramoka178
added
ARMChangesRequested
microsoft-github-policy-service
bot
added
no-recent-activity
Juliehzl
added
WaitForARMFeedback
razvanbadea-msft
added
the
ARMChangesRequested
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
Juliehzl
added
WaitForARMFeedback
|
same change with #29570. please signoff |
ms-bogdan-rotaru
added
the
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
ms-bogdan-rotaru
approved these changes
Jul 31, 2024
ms-bogdan-rotaru
merged commit 0263161
into
Azure:release-app-Microsoft.App-2024-08-02-preview
25 of 28 checks passed
Juliehzl
added a commit
that referenced
this pull request
Sep 24, 2024
* Copy files from preview/2024-02-02-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-08-02-preview Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview. * Added tag for 2024-08-02-preview in readme file * Support spring cloud gateway (#29591) * support scg in 0802preview * fix lint issue --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Add scale property to java component (#29801) * add scale property for jc * swagger prettiercheck * prettier check * the prettier check has a bug * edit description * refine description --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * [Microsoft.App] add debug endpoint on replica container (#29778) * add debug endpoint on replica container * fix code style errors * add example debug endpoint * Update header and query parameter for source control (#29536) * update * fix example * fix * fix * fix * update examples * use v5 * Enable DeploymentErrors for ContainerApps (#29822) * Enable DeploymentErrors for ContainerApps * Add example * Fix format --------- Co-authored-by: layliu <layliu@microsoft.com> * Add dockerfile path argument (#30156) * Add dockerfile path argument * Fix example * Fix example * Fix linting errors * Modify example * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add KEDA cooldownPeriod/pollingInterval property for Container App & Jobs (#30154) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Make the header optional for source control (#30232) * Add includeDapr in traces and include keda in metrics for container app environment (#29987) * Add includeDapr in traces and include keda in metrics * pretty * Fix sessionpool name parameter location (#30231) * Fix sessionpool name parameter location * Prettier * Add job suspend resume (#30304) * add fields * add * Update Jobs.json fix runningState and add azure-asyncoperation * Update Jobs_Resume.json * Update Jobs_Suspend.json * add azure-asyncoperation * fix lintdiff * fix * fix * fix * add * reopen PR & add runningState states --------- Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * add runningState change (#30464) Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * [Microsoft.App] Add enableFips property for dedicated workload profiles (#30418) * enableFips Property for workload profile * Fix description * Add default value for property * run prettier * More prettier fixes * Add system data back for billingMeter (#30627) * Fix CI check for 2024-08-02-preview (#30641) * add suppression for patch java component (#30644) Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Fix session pool error response (#30647) Co-authored-by: Zunli Hu <zuh@microsoft.com> * update --------- Co-authored-by: Xuyang Cao <Elvis_caoxy@163.com> Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> Co-authored-by: Yi Liu <yiliu6@microsoft.com> Co-authored-by: LaylaLiu-gmail <38268900+LaylaLiu-gmail@users.noreply.github.com> Co-authored-by: layliu <layliu@microsoft.com> Co-authored-by: snehapar9 <108305436+snehapar9@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Tara W <tawalke@users.noreply.github.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: yitaopan <yitaopan@microsoft.com> Co-authored-by: bgashirabake <85650284+bgashirabake@users.noreply.github.com> Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> Co-authored-by: Jitin John <jijohn@microsoft.com>
jijohn14
added a commit
that referenced
this pull request
Oct 8, 2024
* Copy files from preview/2024-02-02-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-08-02-preview Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview. * Added tag for 2024-08-02-preview in readme file * Support spring cloud gateway (#29591) * support scg in 0802preview * fix lint issue --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Add scale property to java component (#29801) * add scale property for jc * swagger prettiercheck * prettier check * the prettier check has a bug * edit description * refine description --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * [Microsoft.App] add debug endpoint on replica container (#29778) * add debug endpoint on replica container * fix code style errors * add example debug endpoint * Update header and query parameter for source control (#29536) * update * fix example * fix * fix * fix * update examples * use v5 * Enable DeploymentErrors for ContainerApps (#29822) * Enable DeploymentErrors for ContainerApps * Add example * Fix format --------- Co-authored-by: layliu <layliu@microsoft.com> * Add dockerfile path argument (#30156) * Add dockerfile path argument * Fix example * Fix example * Fix linting errors * Modify example * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add KEDA cooldownPeriod/pollingInterval property for Container App & Jobs (#30154) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Make the header optional for source control (#30232) * Add includeDapr in traces and include keda in metrics for container app environment (#29987) * Add includeDapr in traces and include keda in metrics * pretty * Fix sessionpool name parameter location (#30231) * Fix sessionpool name parameter location * Prettier * Add job suspend resume (#30304) * add fields * add * Update Jobs.json fix runningState and add azure-asyncoperation * Update Jobs_Resume.json * Update Jobs_Suspend.json * add azure-asyncoperation * fix lintdiff * fix * fix * fix * add * reopen PR & add runningState states --------- Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * add runningState change (#30464) Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * [Microsoft.App] Add enableFips property for dedicated workload profiles (#30418) * enableFips Property for workload profile * Fix description * Add default value for property * run prettier * More prettier fixes * Add system data back for billingMeter (#30627) * Fix CI check for 2024-08-02-preview (#30641) * add suppression for patch java component (#30644) Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Fix session pool error response (#30647) Co-authored-by: Zunli Hu <zuh@microsoft.com> * Fix Swagger PrettierCheck for examples (#30674) * Copy files from preview/2024-02-02-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-08-02-preview Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview. * Added tag for 2024-08-02-preview in readme file * Support spring cloud gateway (#29591) * support scg in 0802preview * fix lint issue --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Add scale property to java component (#29801) * add scale property for jc * swagger prettiercheck * prettier check * the prettier check has a bug * edit description * refine description --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * [Microsoft.App] add debug endpoint on replica container (#29778) * add debug endpoint on replica container * fix code style errors * add example debug endpoint * Update header and query parameter for source control (#29536) * update * fix example * fix * fix * fix * update examples * use v5 * Enable DeploymentErrors for ContainerApps (#29822) * Enable DeploymentErrors for ContainerApps * Add example * Fix format --------- Co-authored-by: layliu <layliu@microsoft.com> * Add dockerfile path argument (#30156) * Add dockerfile path argument * Fix example * Fix example * Fix linting errors * Modify example * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add KEDA cooldownPeriod/pollingInterval property for Container App & Jobs (#30154) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Make the header optional for source control (#30232) * Add includeDapr in traces and include keda in metrics for container app environment (#29987) * Add includeDapr in traces and include keda in metrics * pretty * Fix sessionpool name parameter location (#30231) * Fix sessionpool name parameter location * Prettier * Add job suspend resume (#30304) * add fields * add * Update Jobs.json fix runningState and add azure-asyncoperation * Update Jobs_Resume.json * Update Jobs_Suspend.json * add azure-asyncoperation * fix lintdiff * fix * fix * fix * add * reopen PR & add runningState states --------- Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * add runningState change (#30464) Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * [Microsoft.App] Add enableFips property for dedicated workload profiles (#30418) * enableFips Property for workload profile * Fix description * Add default value for property * run prettier * More prettier fixes * Add system data back for billingMeter (#30627) * Fix CI check for 2024-08-02-preview (#30641) * add suppression for patch java component (#30644) Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Fix session pool error response (#30647) Co-authored-by: Zunli Hu <zuh@microsoft.com> * update --------- Co-authored-by: Xuyang Cao <Elvis_caoxy@163.com> Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> Co-authored-by: Yi Liu <yiliu6@microsoft.com> Co-authored-by: LaylaLiu-gmail <38268900+LaylaLiu-gmail@users.noreply.github.com> Co-authored-by: layliu <layliu@microsoft.com> Co-authored-by: snehapar9 <108305436+snehapar9@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Tara W <tawalke@users.noreply.github.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: yitaopan <yitaopan@microsoft.com> Co-authored-by: bgashirabake <85650284+bgashirabake@users.noreply.github.com> Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> Co-authored-by: Jitin John <jijohn@microsoft.com> * revert change (#30700) * Fix default value property error for keda properties - 08.2024 release (#30691) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Remove default for polling and cooldown to fix error-TEW * Add Identity to session pool registry (#30748) * Add Identity to session pool registry * update examples * fix --------- Co-authored-by: Xuyang Cao <Elvis_caoxy@163.com> Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> Co-authored-by: Yi Liu <yiliu6@microsoft.com> Co-authored-by: LaylaLiu-gmail <38268900+LaylaLiu-gmail@users.noreply.github.com> Co-authored-by: layliu <layliu@microsoft.com> Co-authored-by: snehapar9 <108305436+snehapar9@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Tara W <tawalke@users.noreply.github.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: yitaopan <yitaopan@microsoft.com> Co-authored-by: bgashirabake <85650284+bgashirabake@users.noreply.github.com> Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> Co-authored-by: Jitin John <jijohn@microsoft.com> Co-authored-by: najian <jiangnan8924@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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!
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:
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 ApiViewcomment 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
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.