V2: upgrade modulename to v2 (#1552)

* upgrade modulename to v2 * update tmpl files * change import paths * update more import paths * update more import paths * fix go.mod --------- Co-authored-by: Tobias Theel <[email protected]>
swaggo · Apr 17, 2023 · 44b59ad · 44b59ad
1 parent 21247c7
commit 44b59ad
Show file tree

Hide file tree

Showing 94 changed files with 134 additions and 129 deletions.
diff --git a/cmd/swag/main.go b/cmd/swag/main.go
@@ -7,9 +7,9 @@ import (
 	"os"
 	"strings"
 
-	"github.com/swaggo/swag"
-	"github.com/swaggo/swag/format"
-	"github.com/swaggo/swag/gen"
+	"github.com/swaggo/swag/v2"
+	"github.com/swaggo/swag/v2/format"
+	"github.com/swaggo/swag/v2/gen"
 
 	"github.com/urfave/cli/v2"
 )

diff --git a/doc.go b/doc.go
@@ -2,4 +2,4 @@
 Package swag converts Go annotations to Swagger Documentation 2.0.
 See https://github.com/swaggo/swag for more information about swag.
 */
-package swag // import "github.com/swaggo/swag"
+package swag // import "github.com/swaggo/swag/v2"
diff --git a/example/basic/api/api.go b/example/basic/api/api.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"net/http"
 
-	"github.com/swaggo/swag/example/basic/web"
+	"github.com/swaggo/swag/v2/example/basic/web"
 )
 
 // GetStringByInt example

diff --git a/example/basic/docs/docs.go b/example/basic/docs/docs.go
@@ -2,7 +2,7 @@
 // This file was generated by swaggo/swag
 package docs
 
-import "github.com/swaggo/swag"
+import "github.com/swaggo/swag/v2"
 
 const docTemplate = `{
     "schemes": {{ marshal .Schemes }},

diff --git a/example/basic/main.go b/example/basic/main.go
@@ -3,7 +3,7 @@ package main
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/example/basic/api"
+	"github.com/swaggo/swag/v2/example/basic/api"
 )
 
 //	@title			Swagger Example API

diff --git a/example/celler/controller/accounts.go b/example/celler/controller/accounts.go
@@ -6,8 +6,8 @@ import (
 	"strconv"
 
 	"github.com/gin-gonic/gin"
-	"github.com/swaggo/swag/example/celler/httputil"
-	"github.com/swaggo/swag/example/celler/model"
+	"github.com/swaggo/swag/v2/example/celler/httputil"
+	"github.com/swaggo/swag/v2/example/celler/model"
 )
 
 // ShowAccount godoc

diff --git a/example/celler/controller/admin.go b/example/celler/controller/admin.go
@@ -6,8 +6,8 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	"github.com/swaggo/swag/example/celler/httputil"
-	"github.com/swaggo/swag/example/celler/model"
+	"github.com/swaggo/swag/v2/example/celler/httputil"
+	"github.com/swaggo/swag/v2/example/celler/model"
 )
 
 // Auth godoc

diff --git a/example/celler/controller/bottles.go b/example/celler/controller/bottles.go
@@ -5,8 +5,8 @@ import (
 	"strconv"
 
 	"github.com/gin-gonic/gin"
-	"github.com/swaggo/swag/example/celler/httputil"
-	"github.com/swaggo/swag/example/celler/model"
+	"github.com/swaggo/swag/v2/example/celler/httputil"
+	"github.com/swaggo/swag/v2/example/celler/model"
 )
 
 // ShowBottle godoc

diff --git a/example/celler/controller/examples.go b/example/celler/controller/examples.go
@@ -6,7 +6,7 @@ import (
 	"strconv"
 
 	"github.com/gin-gonic/gin"
-	"github.com/swaggo/swag/example/celler/httputil"
+	"github.com/swaggo/swag/v2/example/celler/httputil"
 )
 
 // PingExample godoc

diff --git a/example/celler/go.mod b/example/celler/go.mod
@@ -7,7 +7,7 @@ require (
 	github.com/gofrs/uuid v4.2.0+incompatible
 	github.com/swaggo/files v0.0.0-20210815190702-a29dd2bc99b2
 	github.com/swaggo/gin-swagger v1.4.2
-	github.com/swaggo/swag v1.8.1
+	github.com/swaggo/swag/v2 v2.0.0-beta
 )
 
 require (

diff --git a/example/celler/main.go b/example/celler/main.go
@@ -5,9 +5,9 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	"github.com/swaggo/swag/example/celler/controller"
-	_ "github.com/swaggo/swag/example/celler/docs"
-	"github.com/swaggo/swag/example/celler/httputil"
+	"github.com/swaggo/swag/v2/example/celler/controller"
+	_ "github.com/swaggo/swag/v2/example/celler/docs"
+	"github.com/swaggo/swag/v2/example/celler/httputil"
 
 	swaggerFiles "github.com/swaggo/files"
 	ginSwagger "github.com/swaggo/gin-swagger"

diff --git a/example/markdown/docs/docs.go b/example/markdown/docs/docs.go
@@ -2,7 +2,7 @@
 // This file was generated by swaggo/swag
 package docs
 
-import "github.com/swaggo/swag"
+import "github.com/swaggo/swag/v2"
 
 const docTemplate = `{
     "schemes": {{ marshal .Schemes }},

diff --git a/example/markdown/main.go b/example/markdown/main.go
@@ -1,11 +1,12 @@
 package main
 
 import (
+	"net/http"
+
 	"github.com/gorilla/mux"
 	httpSwagger "github.com/swaggo/http-swagger"
-	"github.com/swaggo/swag/example/markdown/api"
-	_ "github.com/swaggo/swag/example/markdown/docs"
-	"net/http"
+	"github.com/swaggo/swag/v2/example/markdown/api"
+	_ "github.com/swaggo/swag/v2/example/markdown/docs"
 )
 
 // @title Swagger Example API

diff --git a/example/object-map-example/docs/docs.go b/example/object-map-example/docs/docs.go
@@ -2,7 +2,7 @@
 // This file was generated by swaggo/swag
 package docs
 
-import "github.com/swaggo/swag"
+import "github.com/swaggo/swag/v2"
 
 const docTemplate = `{
     "schemes": {{ marshal .Schemes }},

diff --git a/example/object-map-example/main.go b/example/object-map-example/main.go
@@ -2,8 +2,8 @@ package main
 
 import (
 	"github.com/gin-gonic/gin"
-	"github.com/swaggo/swag/example/object-map-example/controller"
-	_ "github.com/swaggo/swag/example/object-map-example/docs"
+	"github.com/swaggo/swag/v2/example/object-map-example/controller"
+	_ "github.com/swaggo/swag/v2/example/object-map-example/docs"
 
 	swaggerFiles "github.com/swaggo/files"
 	ginSwagger "github.com/swaggo/gin-swagger"

diff --git a/example/override/docs/docs.go b/example/override/docs/docs.go
@@ -2,7 +2,7 @@
 // This file was generated by swaggo/swag
 package docs
 
-import "github.com/swaggo/swag"
+import "github.com/swaggo/swag/v2"
 
 const docTemplate = `{
     "schemes": {{ marshal .Schemes }},

diff --git a/format/format.go b/format/format.go
@@ -6,7 +6,7 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/swaggo/swag"
+	"github.com/swaggo/swag/v2"
 )
 
 // Format implements `fmt` command for formatting swag comments in Go source

diff --git a/format/format_test.go b/format/format_test.go
@@ -118,7 +118,7 @@ var testFiles = map[string][]byte{
 		import (
 			"net/http"
 
-			"github.com/swaggo/swag/format/testdata/api"
+			"github.com/swaggo/swag/v2/format/testdata/api"
 		)
 
 		// @title Swagger Example API

diff --git a/gen/gen.go b/gen/gen.go
@@ -21,7 +21,7 @@ import (
 	v2 "github.com/go-openapi/spec"
 	v3 "github.com/sv-tools/openapi/spec"
 
-	"github.com/swaggo/swag"
+	"github.com/swaggo/swag/v2"
 	"sigs.k8s.io/yaml"
 )
 

diff --git a/gen/gen_test.go b/gen/gen_test.go
@@ -16,7 +16,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"github.com/swaggo/swag"
+	"github.com/swaggo/swag/v2"
 )
 
 const searchDir = "../testdata/simple"

diff --git a/gen/src/oas2.tmpl b/gen/src/oas2.tmpl
@@ -2,7 +2,7 @@
 
 package docs
 
-import "github.com/swaggo/swag"
+import "github.com/swaggo/swag/v2"
 
 const docTemplate{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }} = `{{ printDoc .Doc}}`
 

diff --git a/gen/src/oas3.tmpl b/gen/src/oas3.tmpl
@@ -2,7 +2,7 @@
 
 package docs
 
-import "github.com/swaggo/swag"
+import "github.com/swaggo/swag/v2"
 
 const docTemplate{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }} = `{{ printDoc .Doc}}`
 
@@ -17,4 +17,4 @@ var SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }}
 
 func init() {
 	swag.Register(SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }}.InstanceName(), SwaggerInfo{{ if ne .InstanceName "swagger" }}{{ .InstanceName }} {{- end }})
-}
+}
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/swaggo/swag
+module github.com/swaggo/swag/v2
 
 go 1.18
 

diff --git a/golist_test.go b/golist_test.go
@@ -66,7 +66,7 @@ func TestGetAllGoFileInfoFromDepsByList(t *testing.T) {
 			name: "normal",
 			buildPackage: &build.Package{
 				Name:       "main",
-				ImportPath: "github.com/swaggo/swag/testdata/golist",
+				ImportPath: "github.com/swaggo/swag/v2/testdata/golist",
 				Dir:        "testdata/golist",
 				GoFiles:    []string{"main.go"},
 				CgoFiles:   []string{"api/api.go"},

diff --git a/testdata/alias_import/api/api.go b/testdata/alias_import/api/api.go
@@ -4,8 +4,8 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/alias_import/data"
-	"github.com/swaggo/swag/testdata/alias_type/types"
+	"github.com/swaggo/swag/v2/testdata/alias_import/data"
+	"github.com/swaggo/swag/v2/testdata/alias_type/types"
 )
 
 // @Summary Get application

diff --git a/testdata/alias_import/data/applicationresponse.go b/testdata/alias_import/data/applicationresponse.go
@@ -1,7 +1,7 @@
 package data
 
 import (
-	typesapplication "github.com/swaggo/swag/testdata/alias_import/types"
+	typesapplication "github.com/swaggo/swag/v2/testdata/alias_import/types"
 )
 
 type ApplicationResponse struct {

diff --git a/testdata/alias_import/main.go b/testdata/alias_import/main.go
@@ -3,7 +3,7 @@ package alias_import
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/alias_import/api"
+	"github.com/swaggo/swag/v2/testdata/alias_import/api"
 )
 
 // @title Swagger Example API

diff --git a/testdata/alias_type/api/api.go b/testdata/alias_type/api/api.go
@@ -5,7 +5,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/swaggo/swag/testdata/alias_type/data"
+	"github.com/swaggo/swag/v2/testdata/alias_type/data"
 )
 
 /*// @Summary Get time as string

diff --git a/testdata/alias_type/data/alias.go b/testdata/alias_type/data/alias.go
@@ -1,8 +1,9 @@
 package data
 
 import (
-	"github.com/swaggo/swag/testdata/alias_type/types"
 	"time"
+
+	"github.com/swaggo/swag/v2/testdata/alias_type/types"
 )
 
 type TimeContainer struct {

diff --git a/testdata/alias_type/main.go b/testdata/alias_type/main.go
@@ -3,7 +3,7 @@ package alias_type
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/alias_type/api"
+	"github.com/swaggo/swag/v2/testdata/alias_type/api"
 )
 
 // @title Swagger Example API

diff --git a/testdata/code_examples/api/api1.go b/testdata/code_examples/api/api1.go
@@ -1,8 +1,9 @@
 package api
 
 import (
-	_ "github.com/swaggo/swag/testdata/conflict_name/model"
 	"net/http"
+
+	_ "github.com/swaggo/swag/v2/testdata/conflict_name/model"
 )
 
 // @Description  Check if Health  of service it's OK!

diff --git a/testdata/composition/api/api.go b/testdata/composition/api/api.go
@@ -3,7 +3,7 @@ package api
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/composition/common"
+	"github.com/swaggo/swag/v2/testdata/composition/common"
 )
 
 type Foo struct {

diff --git a/testdata/composition/main.go b/testdata/composition/main.go
@@ -3,7 +3,7 @@ package composition
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/composition/api"
+	"github.com/swaggo/swag/v2/testdata/composition/api"
 )
 
 // @title Swagger Example API

diff --git a/testdata/conflict_name/api/api1.go b/testdata/conflict_name/api/api1.go
@@ -1,8 +1,9 @@
 package api
 
 import (
-	_ "github.com/swaggo/swag/testdata/conflict_name/model"
 	"net/http"
+
+	_ "github.com/swaggo/swag/v2/testdata/conflict_name/model"
 )
 
 // @Tags Health

diff --git a/testdata/conflict_name/api/api2.go b/testdata/conflict_name/api/api2.go
@@ -1,8 +1,9 @@
 package api
 
 import (
-	_ "github.com/swaggo/swag/testdata/conflict_name/model2"
 	"net/http"
+
+	_ "github.com/swaggo/swag/v2/testdata/conflict_name/model2"
 )
 
 // @Tags Health

diff --git a/testdata/duplicated/main.go b/testdata/duplicated/main.go
@@ -3,7 +3,7 @@ package composition
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/duplicated/api"
+	"github.com/swaggo/swag/v2/testdata/duplicated/api"
 )
 
 // @title Swagger Example API

diff --git a/testdata/duplicated2/main.go b/testdata/duplicated2/main.go
@@ -3,7 +3,7 @@ package composition
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/duplicated2/api"
+	"github.com/swaggo/swag/v2/testdata/duplicated2/api"
 )
 
 // @title Swagger Example API

diff --git a/testdata/duplicated_function_scoped/main.go b/testdata/duplicated_function_scoped/main.go
@@ -3,8 +3,8 @@ package composition
 import (
 	"net/http"
 
-	"github.com/swaggo/swag/testdata/duplicated_function_scoped/api"
-	otherapi "github.com/swaggo/swag/testdata/duplicated_function_scoped/other_api"
+	"github.com/swaggo/swag/v2/testdata/duplicated_function_scoped/api"
+	otherapi "github.com/swaggo/swag/v2/testdata/duplicated_function_scoped/other_api"
 )
 
 // @title Swagger Example API

diff --git a/testdata/enums/api/api.go b/testdata/enums/api/api.go
@@ -1,6 +1,6 @@
 package api
 
-import "github.com/swaggo/swag/testdata/enums/types"
+import "github.com/swaggo/swag/v2/testdata/enums/types"
 
 //	 post students
 //

diff --git a/testdata/enums/types/model.go b/testdata/enums/types/model.go
@@ -1,7 +1,7 @@
 package types
 
 import (
-	"github.com/swaggo/swag/testdata/enums/consts"
+	"github.com/swaggo/swag/v2/testdata/enums/consts"
 )
 
 type Class int