This is an automated email from the ASF dual-hosted git repository. lynwee pushed a commit to branch lw-update-api-doc in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
commit b91075ec6c1d05a612ba7f0edafa659cea923c9d Author: Lynwee Hou <[email protected]> AuthorDate: Fri Mar 8 17:17:04 2024 +0800 docs(plugins): update path for testing existing connection API --- backend/plugins/ae/api/connection.go | 2 +- backend/plugins/bamboo/api/connection_api.go | 2 +- backend/plugins/bitbucket/api/connection_api.go | 2 +- backend/plugins/bitbucket_server/api/connection.go | 2 +- backend/plugins/circleci/api/connection.go | 2 +- backend/plugins/feishu/api/connection.go | 2 +- backend/plugins/gitee/api/connection.go | 2 +- backend/plugins/github/api/connection_api.go | 2 +- backend/plugins/gitlab/api/connection_api.go | 2 +- backend/plugins/jenkins/api/connection_api.go | 2 +- backend/plugins/jira/api/connection_api.go | 2 +- backend/plugins/opsgenie/api/connection.go | 2 +- backend/plugins/pagerduty/api/connection.go | 2 +- backend/plugins/slack/api/connection.go | 2 +- backend/plugins/sonarqube/api/connection_api.go | 2 +- backend/plugins/tapd/api/connection.go | 2 +- backend/plugins/teambition/api/connection.go | 2 +- backend/plugins/trello/api/connection.go | 2 +- backend/plugins/zentao/api/connection.go | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/backend/plugins/ae/api/connection.go b/backend/plugins/ae/api/connection.go index 5ad29f0f8..2f15da8aa 100644 --- a/backend/plugins/ae/api/connection.go +++ b/backend/plugins/ae/api/connection.go @@ -87,7 +87,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} shared.ApiBody "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/ae/{connectionId}/test [POST] +// @Router /plugins/ae/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { // decode connection := &models.AeConnection{} diff --git a/backend/plugins/bamboo/api/connection_api.go b/backend/plugins/bamboo/api/connection_api.go index cbd13cb27..c15a8b84c 100644 --- a/backend/plugins/bamboo/api/connection_api.go +++ b/backend/plugins/bamboo/api/connection_api.go @@ -84,7 +84,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} BambooTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/bamboo/{connectionId}/test [POST] +// @Router /plugins/bamboo/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.FindByPk(input) if err != nil { diff --git a/backend/plugins/bitbucket/api/connection_api.go b/backend/plugins/bitbucket/api/connection_api.go index 7d7057822..0ce89670f 100644 --- a/backend/plugins/bitbucket/api/connection_api.go +++ b/backend/plugins/bitbucket/api/connection_api.go @@ -98,7 +98,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} BitBucketTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/bitbucket/{connectionId}/test [POST] +// @Router /plugins/bitbucket/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.GetMergedConnection(input) if err != nil { diff --git a/backend/plugins/bitbucket_server/api/connection.go b/backend/plugins/bitbucket_server/api/connection.go index 74353c413..c141849a0 100644 --- a/backend/plugins/bitbucket_server/api/connection.go +++ b/backend/plugins/bitbucket_server/api/connection.go @@ -90,7 +90,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} BitBucketTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/bitbucket_server/{connectionId}/test [POST] +// @Router /plugins/bitbucket_server/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.FindByPk(input) if err != nil { diff --git a/backend/plugins/circleci/api/connection.go b/backend/plugins/circleci/api/connection.go index 909b2c77f..3a356ab84 100644 --- a/backend/plugins/circleci/api/connection.go +++ b/backend/plugins/circleci/api/connection.go @@ -93,7 +93,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} CircleciTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/circleci/{connectionId}/test [POST] +// @Router /plugins/circleci/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.CircleciConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/feishu/api/connection.go b/backend/plugins/feishu/api/connection.go index 6d0abb986..aee55ea42 100644 --- a/backend/plugins/feishu/api/connection.go +++ b/backend/plugins/feishu/api/connection.go @@ -84,7 +84,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} FeishuTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/feishu/{connectionId}/test [POST] +// @Router /plugins/feishu/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.FeishuConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/gitee/api/connection.go b/backend/plugins/gitee/api/connection.go index be61db56d..17d3bcc3e 100644 --- a/backend/plugins/gitee/api/connection.go +++ b/backend/plugins/gitee/api/connection.go @@ -101,7 +101,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} GiteeTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/gitee/{connectionId}/test [POST] +// @Router /plugins/gitee/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.GiteeConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/github/api/connection_api.go b/backend/plugins/github/api/connection_api.go index b02b5ec1a..f4dd4066b 100644 --- a/backend/plugins/github/api/connection_api.go +++ b/backend/plugins/github/api/connection_api.go @@ -386,7 +386,7 @@ func testExistingConnection(ctx context.Context, conn models.GithubConn) (*Githu // @Success 200 {object} GithubMultiTestConnResponse // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/github/{connectionId}/test [POST] +// @Router /plugins/github/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.GetMergedConnection(input) if err != nil { diff --git a/backend/plugins/gitlab/api/connection_api.go b/backend/plugins/gitlab/api/connection_api.go index 5acce35e9..95b551536 100644 --- a/backend/plugins/gitlab/api/connection_api.go +++ b/backend/plugins/gitlab/api/connection_api.go @@ -103,7 +103,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} GitlabTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/gitlab/{connectionId}/test [POST] +// @Router /plugins/gitlab/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.GetMergedConnection(input) if err != nil { diff --git a/backend/plugins/jenkins/api/connection_api.go b/backend/plugins/jenkins/api/connection_api.go index ce2454b0d..ad54cfe35 100644 --- a/backend/plugins/jenkins/api/connection_api.go +++ b/backend/plugins/jenkins/api/connection_api.go @@ -104,7 +104,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} JenkinsTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/jenkins/{connectionId}/test [POST] +// @Router /plugins/jenkins/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.GetMergedConnection(input) if err != nil { diff --git a/backend/plugins/jira/api/connection_api.go b/backend/plugins/jira/api/connection_api.go index b06840260..0a6175fc4 100644 --- a/backend/plugins/jira/api/connection_api.go +++ b/backend/plugins/jira/api/connection_api.go @@ -149,7 +149,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} JiraTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/jira/{connectionId}/test [POST] +// @Router /plugins/jira/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.GetMergedConnection(input) if err != nil { diff --git a/backend/plugins/opsgenie/api/connection.go b/backend/plugins/opsgenie/api/connection.go index 8cc7340b3..bd666d039 100644 --- a/backend/plugins/opsgenie/api/connection.go +++ b/backend/plugins/opsgenie/api/connection.go @@ -65,7 +65,7 @@ func testOpsgenieConn(ctx context.Context, connection models.OpsgenieConn) (*plu // @Success 200 {object} shared.ApiBody "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/opsgenie/{connectionId}/test [POST] +// @Router /plugins/opsgenie/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.OpsgenieConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/pagerduty/api/connection.go b/backend/plugins/pagerduty/api/connection.go index 13be31f96..fbf09a70b 100644 --- a/backend/plugins/pagerduty/api/connection.go +++ b/backend/plugins/pagerduty/api/connection.go @@ -79,7 +79,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} shared.ApiBody "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/pagerduty/{connectionId}/test [POST] +// @Router /plugins/pagerduty/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.PagerDutyConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/slack/api/connection.go b/backend/plugins/slack/api/connection.go index 466288163..fd13d7ef6 100644 --- a/backend/plugins/slack/api/connection.go +++ b/backend/plugins/slack/api/connection.go @@ -84,7 +84,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} SlackTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/slack/{connectionId}/test [POST] +// @Router /plugins/slack/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.SlackConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/sonarqube/api/connection_api.go b/backend/plugins/sonarqube/api/connection_api.go index 44d2c3b71..536ae8576 100644 --- a/backend/plugins/sonarqube/api/connection_api.go +++ b/backend/plugins/sonarqube/api/connection_api.go @@ -110,7 +110,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} SonarqubeTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/sonarqube/{connectionId}/test [POST] +// @Router /plugins/sonarqube/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection, err := dsHelper.ConnApi.GetMergedConnection(input) if err != nil { diff --git a/backend/plugins/tapd/api/connection.go b/backend/plugins/tapd/api/connection.go index 56b09e92b..f701f1b7f 100644 --- a/backend/plugins/tapd/api/connection.go +++ b/backend/plugins/tapd/api/connection.go @@ -97,7 +97,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} TapdTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/tapd/{connectionId}/test [POST] +// @Router /plugins/tapd/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.TapdConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/teambition/api/connection.go b/backend/plugins/teambition/api/connection.go index 1d935f06d..167863060 100644 --- a/backend/plugins/teambition/api/connection.go +++ b/backend/plugins/teambition/api/connection.go @@ -111,7 +111,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} TeambitionTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/teambition/{connectionId}/test [POST] +// @Router /plugins/teambition/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.TeambitionConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/trello/api/connection.go b/backend/plugins/trello/api/connection.go index 0ca05430d..f57e69292 100644 --- a/backend/plugins/trello/api/connection.go +++ b/backend/plugins/trello/api/connection.go @@ -97,7 +97,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} TrelloTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/trello/{connectionId}/test [POST] +// @Router /plugins/trello/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.TrelloConnection{} err := connectionHelper.First(connection, input.Params) diff --git a/backend/plugins/zentao/api/connection.go b/backend/plugins/zentao/api/connection.go index 7be4a768b..d7cdf6fab 100644 --- a/backend/plugins/zentao/api/connection.go +++ b/backend/plugins/zentao/api/connection.go @@ -104,7 +104,7 @@ func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, // @Success 200 {object} ZentaoTestConnResponse "Success" // @Failure 400 {string} errcode.Error "Bad Request" // @Failure 500 {string} errcode.Error "Internal Error" -// @Router /plugins/zentao/{connectionId}/test [POST] +// @Router /plugins/zentao/connections/{connectionId}/test [POST] func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error) { connection := &models.ZentaoConnection{} err := connectionHelper.First(connection, input.Params)
