Skip to content

Update header and query parameter for source control #29536

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.

Sign up for GitHub

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

Merged
ms-bogdan-rotaru merged 8 commits into from
Jul 31, 2024
Merged

Update header and query parameter for source control #29536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d236a19
update
Juliehzl Jun 21, 2024
76ada3c
fix example
Juliehzl Jun 21, 2024
b210a6d
fix
Juliehzl Jun 25, 2024
a2f5944
fix
Juliehzl Jun 25, 2024
189d172
fix
Juliehzl Jun 26, 2024
f140c31
update examples
Juliehzl Jun 28, 2024
5e86fd0
use v5
Juliehzl Jul 30, 2024
99c9f1a
Merge branch 'release-app-Microsoft.App-2024-08-02-preview' into user…
Juliehzl Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 40 additions & 13 deletions ...ication/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@
"operationId": "ContainerAppsSourceControls_ListByContainerApp",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
Expand All @@ -55,7 +55,7 @@
"type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
Expand Down Expand Up @@ -91,10 +91,10 @@
"operationId": "ContainerAppsSourceControls_Get",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
Expand All @@ -111,7 +111,7 @@
"type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
Expand Down Expand Up @@ -143,10 +143,10 @@
"operationId": "ContainerAppsSourceControls_CreateOrUpdate",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
Expand All @@ -172,7 +172,14 @@
}
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
"name": "x-ms-github-auxiliary",
"in": "header",
"description": "Github personal access token used for SourceControl.",
"required": true,
"type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
Expand Down Expand Up @@ -211,10 +218,10 @@
"operationId": "ContainerAppsSourceControls_Delete",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
Expand All @@ -231,7 +238,28 @@
"type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
"name": "x-ms-github-auxiliary",
"in": "header",
"description": "Github personal access token used for SourceControl.",
"required": true,
"type": "string"
},
{
"name": "ignoreWorkflowDeletionFailure",
"in": "query",
"description": "Ignore Workflow Deletion Failure.",
"required": false,
"type": "boolean"
},
{
"name": "deleteWorkflow",
"in": "query",
"description": "Delete workflow.",
"required": false,
"type": "boolean"
},
Copy link
Contributor

@ramoka178 ramoka178 Jun 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ?

Copy link
Contributor Author

@Juliehzl Juliehzl Jun 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@ramoka178 ramoka178 Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ?

Copy link
Member

@harryli0108 harryli0108 Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@ramoka178 ramoka178 Jun 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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

Copy link
Member

@razvanbadea-msft razvanbadea-msft Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you get a review for this matter?

Copy link
Contributor Author

@Juliehzl Juliehzl Jul 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
Expand Down Expand Up @@ -454,4 +482,3 @@
}
}
}

2 changes: 1 addition & 1 deletion ...ager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_CreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"resourceGroupName": "workerapps-rg-xj",
"containerAppName": "testcanadacentral",
"sourceControlName": "current",
"x-ms-github-auxiliary": "githubaccesstoken",
"api-version": "2024-08-02-preview",
"sourceControlEnvelope": {
"properties": {
Expand Down Expand Up @@ -105,4 +106,3 @@
}
}
}

4 changes: 3 additions & 1 deletion ...urce-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
"resourceGroupName": "workerapps-rg-xj",
"containerAppName": "testcanadacentral",
"sourceControlName": "current",
"x-ms-github-auxiliary": "githubaccesstoken",
"ignoreWorkflowDeletionFailure": false,
"deleteWorkflow": false,
"api-version": "2024-08-02-preview"
},
"responses": {
Expand All @@ -16,4 +19,3 @@
"204": {}
}
}