[incubator-devlake] branch main updated: fix(sonarqube): add connection swagger (#4430)

[warren]

This is an automated email from the ASF dual-hosted git repository.

warren pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new c30044d81 fix(sonarqube): add connection swagger (#4430)
c30044d81 is described below

commit c30044d811637e99df795a53141e557dc87b9165
Author: Warren Chen <yingchu.c...@merico.dev>
AuthorDate: Thu Feb 16 11:39:45 2023 +0800

    fix(sonarqube): add connection swagger (#4430)
---
 backend/plugins/sonarqube/api/connection.go | 72 +++++++++++++++--------------
 1 file changed, 38 insertions(+), 34 deletions(-)

diff --git a/backend/plugins/sonarqube/api/connection.go 
b/backend/plugins/sonarqube/api/connection.go
index aa0b80fa5..378bb1f5d 100644
--- a/backend/plugins/sonarqube/api/connection.go
+++ b/backend/plugins/sonarqube/api/connection.go
@@ -47,7 +47,7 @@ func TestConnection(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput,
        if err = api.Decode(input.Body, &connection, vld); err != nil {
                return nil, err
        }
-       apiClient, err := api.NewApiClientFromConnection(context.TODO(), 
basicRes, connection)
+       apiClient, err := api.NewApiClientFromConnection(context.TODO(), 
basicRes, &connection)
        if err != nil {
                return nil, err
        }
@@ -74,15 +74,14 @@ func TestConnection(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput,
        }
 }
 
-/*
-POST /plugins/Sonarqube/connections
-
-       {
-               "name": "Sonarqube data connection name",
-               "endpoint": "Sonarqube api endpoint, i.e. 
http://host:port/api/";,
-               "token": "Sonarqube user token"
-       }
-*/
+// @Summary create sonarqube connection
+// @Description Create sonarqube connection
+// @Tags plugins/sonarqube
+// @Param body body models.SonarqubeConnection true "json body"
+// @Success 200  {object} models.SonarqubeConnection
+// @Failure 400  {string} errcode.Error "Bad Request"
+// @Failure 500  {string} errcode.Error "Internal Error"
+// @Router /plugins/sonarqube/connections [POST]
 func PostConnections(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput, errors.Error) {
        // update from request and save to database
        connection := &models.SonarqubeConnection{}
@@ -93,15 +92,14 @@ func PostConnections(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput,
        return &plugin.ApiResourceOutput{Body: connection, Status: 
http.StatusOK}, nil
 }
 
-/*
-PATCH /plugins/Sonarqube/connections/:connectionId
-
-       {
-               "name": "Sonarqube data connection name",
-               "endpoint": "Sonarqube api endpoint, i.e. 
http://host:port/api/";,
-               "token": "Sonarqube user token"
-       }
-*/
+// @Summary patch sonarqube connection
+// @Description Patch sonarqube connection
+// @Tags plugins/sonarqube
+// @Param body body models.SonarqubeConnection true "json body"
+// @Success 200  {object} models.SonarqubeConnection
+// @Failure 400  {string} errcode.Error "Bad Request"
+// @Failure 500  {string} errcode.Error "Internal Error"
+// @Router /plugins/sonarqube/connections/{connectionId} [PATCH]
 func PatchConnection(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput, errors.Error) {
        connection := &models.SonarqubeConnection{}
        err := connectionHelper.Patch(connection, input)
@@ -111,9 +109,13 @@ func PatchConnection(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput,
        return &plugin.ApiResourceOutput{Body: connection}, nil
 }
 
-/*
-DELETE /plugins/Sonarqube/connections/:connectionId
-*/
+// @Summary delete a sonarqube connection
+// @Description Delete a sonarqube connection
+// @Tags plugins/sonarqube
+// @Success 200  {object} models.SonarqubeConnection
+// @Failure 400  {string} errcode.Error "Bad Request"
+// @Failure 500  {string} errcode.Error "Internal Error"
+// @Router /plugins/sonarqube/connections/{connectionId} [DELETE]
 func DeleteConnection(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput, errors.Error) {
        connection := &models.SonarqubeConnection{}
        err := connectionHelper.First(connection, input.Params)
@@ -124,9 +126,13 @@ func DeleteConnection(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput
        return &plugin.ApiResourceOutput{Body: connection}, err
 }
 
-/*
-GET /plugins/Sonarqube/connections
-*/
+// @Summary get all sonarqube connections
+// @Description Get all sonarqube connections
+// @Tags plugins/sonarqube
+// @Success 200  {object} []models.SonarqubeConnection
+// @Failure 400  {string} errcode.Error "Bad Request"
+// @Failure 500  {string} errcode.Error "Internal Error"
+// @Router /plugins/sonarqube/connections [GET]
 func ListConnections(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput, errors.Error) {
        var connections []models.SonarqubeConnection
        err := connectionHelper.List(&connections)
@@ -136,15 +142,13 @@ func ListConnections(input *plugin.ApiResourceInput) 
(*plugin.ApiResourceOutput,
        return &plugin.ApiResourceOutput{Body: connections, Status: 
http.StatusOK}, nil
 }
 
-/*
-GET /plugins/Sonarqube/connections/:connectionId
-
-       {
-               "name": "Sonarqube data connection name",
-               "endpoint": "Sonarqube api endpoint, i.e. 
http://host:port/api/";,
-               "token": "Sonarqube user token"
-       }
-*/
+// @Summary get sonarqube connection detail
+// @Description Get sonarqube connection detail
+// @Tags plugins/sonarqube
+// @Success 200  {object} models.SonarqubeConnection
+// @Failure 400  {string} errcode.Error "Bad Request"
+// @Failure 500  {string} errcode.Error "Internal Error"
+// @Router /plugins/sonarqube/connections/{connectionId} [GET]
 func GetConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, 
errors.Error) {
        connection := &models.SonarqubeConnection{}
        err := connectionHelper.First(connection, input.Params)