fix: add connectionId params on swag (#7152)

apache · Mar 8, 2024 · a502476 · a502476
1 parent 9709550
commit a502476
Show file tree

Hide file tree

Showing 19 changed files with 19 additions and 0 deletions.
diff --git a/backend/plugins/ae/api/connection.go b/backend/plugins/ae/api/connection.go
@@ -84,6 +84,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test ae connection
 // @Description Test AE Connection
 // @Tags plugins/ae
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} shared.ApiBody "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/bamboo/api/connection_api.go b/backend/plugins/bamboo/api/connection_api.go
@@ -81,6 +81,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test bamboo connection
 // @Description Test bamboo Connection
 // @Tags plugins/bamboo
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} BambooTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/bitbucket/api/connection_api.go b/backend/plugins/bitbucket/api/connection_api.go
@@ -95,6 +95,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test bitbucket connection
 // @Description Test bitbucket Connection
 // @Tags plugins/bitbucket
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} BitBucketTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/bitbucket_server/api/connection.go b/backend/plugins/bitbucket_server/api/connection.go
@@ -87,6 +87,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test bitbucket connection
 // @Description Test bitbucket Connection
 // @Tags plugins/bitbucket
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} BitBucketTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/circleci/api/connection.go b/backend/plugins/circleci/api/connection.go
@@ -90,6 +90,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test circleci connection
 // @Description Test circleci Connection
 // @Tags plugins/circleci
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} CircleciTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/feishu/api/connection.go b/backend/plugins/feishu/api/connection.go
@@ -81,6 +81,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test feishu connection
 // @Description Test feishu Connection. endpoint: https://open.feishu.cn/open-apis/
 // @Tags plugins/feishu
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} FeishuTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/gitee/api/connection.go b/backend/plugins/gitee/api/connection.go
@@ -98,6 +98,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test gitee connection
 // @Description Test gitee Connection. endpoint: https://gitee.com/api/v5/
 // @Tags plugins/gitee
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} GiteeTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/github/api/connection_api.go b/backend/plugins/github/api/connection_api.go
@@ -383,6 +383,7 @@ func testExistingConnection(ctx context.Context, conn models.GithubConn) (*Githu
 // @Summary test github connection
 // @Description Test github Connection
 // @Tags plugins/github
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} GithubMultiTestConnResponse
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/gitlab/api/connection_api.go b/backend/plugins/gitlab/api/connection_api.go
@@ -100,6 +100,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test gitlab connection
 // @Description Test gitlab Connection
 // @Tags plugins/gitlab
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} GitlabTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/jenkins/api/connection_api.go b/backend/plugins/jenkins/api/connection_api.go
@@ -101,6 +101,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test jenkins connection
 // @Description Test Jenkins Connection
 // @Tags plugins/jenkins
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} JenkinsTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/jira/api/connection_api.go b/backend/plugins/jira/api/connection_api.go
@@ -146,6 +146,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test jira connection
 // @Description Test Jira Connection
 // @Tags plugins/jira
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} JiraTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/opsgenie/api/connection.go b/backend/plugins/opsgenie/api/connection.go
@@ -62,6 +62,7 @@ func testOpsgenieConn(ctx context.Context, connection models.OpsgenieConn) (*plu
 // @Summary test opsgenie connection
 // @Description Test Opsgenie Connection
 // @Tags plugins/opsgenie
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} shared.ApiBody "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/pagerduty/api/connection.go b/backend/plugins/pagerduty/api/connection.go
@@ -76,6 +76,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test pagerduty connection
 // @Description Test Pagerduty Connection
 // @Tags plugins/pagerduty
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} shared.ApiBody "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/slack/api/connection.go b/backend/plugins/slack/api/connection.go
@@ -81,6 +81,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test slack connection
 // @Description Test slack Connection. endpoint: https://open.slack.cn/open-apis/
 // @Tags plugins/slack
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} SlackTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/sonarqube/api/connection_api.go b/backend/plugins/sonarqube/api/connection_api.go
@@ -107,6 +107,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test sonarqube connection
 // @Description Test sonarqube Connection
 // @Tags plugins/sonarqube
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} SonarqubeTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/tapd/api/connection.go b/backend/plugins/tapd/api/connection.go
@@ -94,6 +94,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test tapd connection
 // @Description Test Tapd Connection
 // @Tags plugins/tapd
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} TapdTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/teambition/api/connection.go b/backend/plugins/teambition/api/connection.go
@@ -108,6 +108,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test teambition connection
 // @Description Test teambition Connection
 // @Tags plugins/teambition
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} TeambitionTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/trello/api/connection.go b/backend/plugins/trello/api/connection.go
@@ -94,6 +94,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test trello connection
 // @Description Test trello Connection
 // @Tags plugins/trello
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} TrelloTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"

diff --git a/backend/plugins/zentao/api/connection.go b/backend/plugins/zentao/api/connection.go
@@ -101,6 +101,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput,
 // @Summary test zentao connection
 // @Description Test zentao Connection
 // @Tags plugins/zentao
+// @Param connectionId path int true "connection ID"
 // @Success 200  {object} ZentaoTestConnResponse "Success"
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"