You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2023/10/27 08:36:20 UTC

(incubator-devlake) branch kw-swagdoc-500 created (now dc7297b63)

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

klesh pushed a change to branch kw-swagdoc-500
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


      at dc7297b63 fix: swag doc 500 / PLUGIN option not working

This branch includes the following new commits:

     new dc7297b63 fix: swag doc 500 / PLUGIN option not working

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(incubator-devlake) 01/01: fix: swag doc 500 / PLUGIN option not working

Posted by kl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch kw-swagdoc-500
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git

commit dc7297b63864cdcce8308cd371cd804f05ad9db6
Author: Klesh Wong <zh...@merico.dev>
AuthorDate: Fri Oct 27 16:36:10 2023 +0800

    fix: swag doc 500 / PLUGIN option not working
---
 backend/Makefile                          | 13 +---------
 backend/plugins/gitlab/api/scope_api.go   |  2 +-
 backend/plugins/webhook/api/connection.go |  9 ++++---
 backend/scripts/swag.sh                   | 41 +++++++++++++++++++++++++++++++
 4 files changed, 48 insertions(+), 17 deletions(-)

diff --git a/backend/Makefile b/backend/Makefile
index 48dc38725..8f9ba6bd9 100644
--- a/backend/Makefile
+++ b/backend/Makefile
@@ -35,18 +35,7 @@ python-dep:
 dep: go-dep python-dep
 
 swag:
-	if [ -z $(PLUGIN) ]; then \
-		swag init --parseDependency --parseInternal -o ./server/api/docs -g ./server/api/api.go -g ./plugins/*/api/*.go; \
-	elif [ $(PLUGIN) = "none" ]; then \
-		swag init --parseDependency --parseInternal -o ./server/api/docs -g ./server/api/api.go;\
-	else \
-		plugins="";\
-		for p in $$(echo $(PLUGIN) | tr "," "\n"); do \
-			plugins="$$plugins -g ./plugins/$$p/api/*.go"; \
-		done;\
-		swag init --parseDependency --parseInternal -o ./server/api/docs -g ./server/api/api.go "$$plugins"; \
-	fi;\
-	echo "visit the swagger document on http://localhost:8080/swagger/index.html";
+	scripts/swag.sh
 
 build-plugin:
 	if [ "$(PLUGIN)" = "none" ]; then \
diff --git a/backend/plugins/gitlab/api/scope_api.go b/backend/plugins/gitlab/api/scope_api.go
index ebdb2e2eb..fb518b88a 100644
--- a/backend/plugins/gitlab/api/scope_api.go
+++ b/backend/plugins/gitlab/api/scope_api.go
@@ -81,7 +81,7 @@ func GetScopeList(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, er
 // @Param scopeId path int false "project ID"
 // @Param pageSize query int false "page size, default 50"
 // @Param page query int false "page size, default 1"
-// @Success 200  {object} ScopeRes
+// @Success 200  {object} ScopeDetail
 // @Failure 400  {object} shared.ApiBody "Bad Request"
 // @Failure 500  {object} shared.ApiBody "Internal Error"
 // @Router /plugins/gitlab/connections/{connectionId}/scopes/{scopeId} [GET]
diff --git a/backend/plugins/webhook/api/connection.go b/backend/plugins/webhook/api/connection.go
index 121377798..f3c9e9116 100644
--- a/backend/plugins/webhook/api/connection.go
+++ b/backend/plugins/webhook/api/connection.go
@@ -19,20 +19,21 @@ package api
 
 import (
 	"fmt"
+	"net/http"
+	"strconv"
+
 	"github.com/apache/incubator-devlake/core/dal"
 	"github.com/apache/incubator-devlake/core/errors"
 	coreModels "github.com/apache/incubator-devlake/core/models"
 	"github.com/apache/incubator-devlake/core/plugin"
 	"github.com/apache/incubator-devlake/plugins/webhook/models"
-	"net/http"
-	"strconv"
 )
 
 // PostConnections
 // @Summary create webhook connection
 // @Description Create webhook connection, example: {"name":"Webhook data connection name"}
 // @Tags plugins/webhook
-// @Param body body models.WebhookConnection true "json body"
+// @Param body body WebhookConnectionResponse true "json body"
 // @Success 200  {object} WebhookConnectionResponse
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"
@@ -143,7 +144,7 @@ type WebhookConnectionResponse struct {
 // @Summary get all webhook connections
 // @Description Get all webhook connections
 // @Tags plugins/webhook
-// @Success 200  {object} []*WebhookConnectionResponse
+// @Success 200  {object} []WebhookConnectionResponse
 // @Failure 400  {string} errcode.Error "Bad Request"
 // @Failure 500  {string} errcode.Error "Internal Error"
 // @Router /plugins/webhook/connections [GET]
diff --git a/backend/scripts/swag.sh b/backend/scripts/swag.sh
new file mode 100755
index 000000000..ae7ec4e3b
--- /dev/null
+++ b/backend/scripts/swag.sh
@@ -0,0 +1,41 @@
+#!/bin/sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -e
+
+ROOT_DIR=$(dirname $(dirname "$0"))
+
+echo $ROOT_DIR
+# generate all docs by default, set the working dir (-d .) to root and general api info file (-g ./server/api/api.go).
+DOC_DIRS=$ROOT_DIR
+GENERAL_API_INFO_PATH=$ROOT_DIR/server/api/api.go
+
+
+if [ -n "$DEVLAKE_PLUGINS" ]; then
+  # change doc dir to avoid generating all docs (-d ./server/api)
+  DOC_DIRS=$ROOT_DIR/server/api
+  GENERAL_API_INFO_PATH=api.go
+  if ! [ "$DEVLAKE_PLUGINS" = "none" ]; then
+    # append plugin dirs to the doc dirs
+    for plugin in $(echo $DEVLAKE_PLUGINS | tr "," "\n"); do
+      DOC_DIRS="$DOC_DIRS,$ROOT_DIR/plugins/$plugin"
+    done
+  fi
+fi
+
+swag init --parseDependency --parseInternal -o $DIR/server/api/docs -g $GENERAL_API_INFO_PATH -d $DOC_DIRS
+echo "visit the swagger document on http://localhost:8080/swagger/index.html";
\ No newline at end of file