fix: lint and docs

bancodobrasil · Oct 14, 2022 · c65ce71 · c65ce71
1 parent 5cbf02e
commit c65ce71
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 25 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -33,7 +33,8 @@ jobs:
     - name: "Run golint"
       if: ${{ matrix.go_version == env.LATEST_GO_VERSION && matrix.os == 'ubuntu-latest'}}
       run: |
-          make lint
+          go install golang.org/x/lint/golint@latest
+          golint -set_exit_status $1 ./...
           exit $1
 
     - name: "Run gofmt"

diff --git a/docs/docs.go b/docs/docs.go
@@ -397,7 +397,10 @@ const docTemplate = `{
                 },
                 "features": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
                 },
                 "hasStringRule": {
                     "type": "boolean"
@@ -410,7 +413,10 @@ const docTemplate = `{
                 },
                 "parameters": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
                 },
                 "rules": {
                     "type": "object",

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -390,7 +390,10 @@
                 },
                 "features": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
                 },
                 "hasStringRule": {
                     "type": "boolean"
@@ -403,7 +406,10 @@
                 },
                 "parameters": {
                     "type": "array",
-                    "items": {}
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
                 },
                 "rules": {
                     "type": "object",

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -13,7 +13,9 @@ definitions:
       description:
         type: string
       features:
-        items: {}
+        items:
+          additionalProperties: true
+          type: object
         type: array
       hasStringRule:
         type: boolean
@@ -22,7 +24,9 @@ definitions:
       name:
         type: string
       parameters:
-        items: {}
+        items:
+          additionalProperties: true
+          type: object
         type: array
       rules:
         additionalProperties: true

diff --git a/middlewares/middlewares.go b/middlewares/middlewares.go
@@ -2,10 +2,12 @@ package middlewares
 
 import "github.com/gin-gonic/gin"
 
+// Middleware ...
 type Middleware interface {
 	Run()
 }
 
+// InitializeMiddlewares ...
 func InitializeMiddlewares() {
 	NewVerifyAuthTokenMiddleware()
 }

diff --git a/middlewares/verify_auth_token.go b/middlewares/verify_auth_token.go
@@ -14,6 +14,7 @@ import (
 	"github.com/lestrrat-go/jwx/v2/jws"
 )
 
+// VerifyAuthTokenMiddleware ...
 type VerifyAuthTokenMiddleware struct {
 	url               string
 	ctx               context.Context
@@ -22,11 +23,12 @@ type VerifyAuthTokenMiddleware struct {
 
 var verifyAuthTokenMiddleware *VerifyAuthTokenMiddleware
 
-// Middleware function to verify the JWT token
+// VerifyAuthToken Middleware function to verify the JWT token
 func VerifyAuthToken() gin.HandlerFunc {
 	return verifyAuthTokenMiddleware.Run()
 }
 
+// NewVerifyAuthTokenMiddleware ...
 func NewVerifyAuthTokenMiddleware() {
 	cfg := config.GetConfig()
 	ctx := context.Background()
@@ -49,6 +51,7 @@ func (m *VerifyAuthTokenMiddleware) setup() {
 	}
 }
 
+// Run ...
 func (m *VerifyAuthTokenMiddleware) Run() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		token := m.extractTokenFromHeader(c)

diff --git a/routes/routes.go b/routes/routes.go
@@ -24,23 +24,6 @@ func SetupRoutes(router *gin.Engine) {
 	router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
 }
 
-// SetupRoutes define all routes
-func SetupRoutesWithReturn() *gin.Engine {
-
-	router := gin.Default()
-
-	cfg := config.GetConfig()
-
-	docs.SwaggerInfo.Host = cfg.ExternalHost
-
-	homeRouter(router.Group("/"))
-	health.Router(router.Group("/health"))
-	// setup swagger docs
-	router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
-
-	return router
-}
-
 // APIRoutes define all api routes
 func APIRoutes(router *gin.Engine) {
 	// inject middleware