Merge pull request #55 from raghavyuva/feat/develop

fix(docs):documentation build errors

Author: raghavyuva

.github/workflows/docs.yml

@@ -0,0 +1,68 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Install dependencies
+        run: |
+          cd docs
+          yarn install --frozen-lockfile
+
+      - name: Build with VitePress
+        run: |
+          cd docs
+          yarn docs:build
+
+      - name: Ensure CNAME exists
+        run: |
+          if [ ! -f docs/.vitepress/dist/CNAME ]; then
+            cp docs/public/CNAME docs/.vitepress/dist/CNAME
+          fi
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 

.gitignore

@@ -3,4 +3,8 @@ api/tmp
 api/bin/
 .env
 data
-node_modules
+node_modules
+.cache
+dist
+docs/.vitepress/dist
+docs/.vitepress/cache

api/api/versions.json

@@ -3,7 +3,7 @@
     {
       "version": "v1",
       "status": "active",
-      "release_date": "2025-04-18T12:57:36.759014+05:30",
+      "release_date": "2025-04-18T16:26:18.53547+05:30",
       "end_of_life": "0001-01-01T00:00:00Z",
       "changes": [
         "Initial API version"

api/doc/openapi.json

@@ -3,34 +3,33 @@ package controller
 import (
 	"net/http"
 
+	"github.com/go-fuego/fuego"
 	"github.com/raghavyuva/nixopus-api/internal/features/logger"
 	"github.com/raghavyuva/nixopus-api/internal/features/organization/types"
-	"github.com/raghavyuva/nixopus-api/internal/utils"
+	shared_types "github.com/raghavyuva/nixopus-api/internal/types"
 )
 
-// GetOrganization godoc
-// @Summary Get an organization
-// @Description Retrieves an organization by its ID.
-// @Tags organization
-// @Accept json
-// @Produce json
-// @Security BearerAuth
-// @Param id path string true "Organization ID"
-// @Success 200 {object} types.Organization "Success response with organization"
-// @Failure 400 {object} types.Response "Bad request"
-// @Failure 500 {object} types.Response "Internal server error"
-// @Router /organization/{id} [get]
-func (c *OrganizationsController) GetOrganization(w http.ResponseWriter, r *http.Request) {
-	id := r.URL.Query().Get("id")
+func (c *OrganizationsController) GetOrganization(f fuego.ContextNoBody) (*shared_types.Response, error) {
+	id := f.QueryParam("id")
 	if err := c.validator.ValidateID(id, types.ErrMissingOrganizationID); err != nil {
 		c.logger.Log(logger.Error, err.Error(), "")
-		utils.SendErrorResponse(w, err.Error(), http.StatusBadRequest)
-		return
+		return nil, fuego.HTTPError{
+			Err:    err,
+			Status: http.StatusBadRequest,
+		}
 	}
+
 	organization, err := c.service.GetOrganization(id)
 	if err != nil {
-		utils.SendErrorResponse(w, err.Error(), http.StatusInternalServerError)
-		return
+		return nil, fuego.HTTPError{
+			Err:    err,
+			Status: http.StatusInternalServerError,
+		}
 	}
-	utils.SendJSONResponse(w, "success", "Organization fetched successfully", organization)
+
+	return &shared_types.Response{
+		Status:  "success",
+		Message: "Organization fetched successfully",
+		Data:    organization,
+	}, nil
 }

api/internal/features/organization/controller/get_organization.go

@@ -3,26 +3,24 @@ package controller
 import (
 	"net/http"
 
+	"github.com/go-fuego/fuego"
 	"github.com/raghavyuva/nixopus-api/internal/features/logger"
-	"github.com/raghavyuva/nixopus-api/internal/utils"
+	shared_types "github.com/raghavyuva/nixopus-api/internal/types"
 )
 
-// GetOrganizations godoc
-// @Summary Get all organizations
-// @Description Retrieves all organizations.
-// @Tags organization
-// @Accept json
-// @Produce json
-// @Security BearerAuth
-// @Success 200 {array} types.Organization "Success response with organizations"
-// @Failure 500 {object} types.Response "Internal server error"
-// @Router /organizations [get]
-func (c *OrganizationsController) GetOrganizations(w http.ResponseWriter, r *http.Request) {
+func (c *OrganizationsController) GetOrganizations(f fuego.ContextNoBody) (*shared_types.Response, error) {
 	organizations, err := c.service.GetOrganizations()
 	if err != nil {
 		c.logger.Log(logger.Error, err.Error(), "")
-		utils.SendErrorResponse(w, err.Error(), http.StatusInternalServerError)
-		return
+		return nil, fuego.HTTPError{
+			Err:    err,
+			Status: http.StatusInternalServerError,
+		}
 	}
-	utils.SendJSONResponse(w, "success", "Organizations fetched successfully", organizations)
+
+	return &shared_types.Response{
+		Status:  "success",
+		Message: "Organizations fetched successfully",
+		Data:    organizations,
+	}, nil
 }

api/internal/features/organization/controller/get_organizations.go

@@ -8,16 +8,6 @@ import (
 	shared_types "github.com/raghavyuva/nixopus-api/internal/types"
 )
 
-// GetRoles godoc
-// @Summary Get all roles with permissions
-// @Description Retrieves all roles with their permissions in the database
-// @Tags organization
-// @Accept json
-// @Produce json
-// @Security BearerAuth
-// @Success 200 {array} types.Role "Success response with roles and permissions"
-// @Failure 500 {object} types.Response "Internal server error"
-// @Router /organizations/roles [get]
 func (c *OrganizationsController) GetRoles(f fuego.ContextNoBody) (*shared_types.Response, error) {
 	c.logger.Log(logger.Info, "getting all roles with permissions", "")
 

api/internal/features/organization/controller/get_roles.go

@@ -13,7 +13,6 @@ import (
 	role_storage "github.com/raghavyuva/nixopus-api/internal/features/role/storage"
 	shared_storage "github.com/raghavyuva/nixopus-api/internal/storage"
 	shared_types "github.com/raghavyuva/nixopus-api/internal/types"
-	"github.com/raghavyuva/nixopus-api/internal/utils"
 )
 
 type OrganizationsController struct {
@@ -44,38 +43,6 @@ func NewOrganizationsController(
 	}
 }
 
-// parseAndValidate parses and validates the request body.
-//
-// This method attempts to parse the request body into the provided 'req' interface
-// using the controller's validator. If parsing fails, an error response is sent
-// and the method returns false. It also validates the parsed request object and
-// returns false if validation fails. If both operations are successful, it returns true.
-//
-// Parameters:
-//
-//	w - the HTTP response writer to send error responses.
-//	r - the HTTP request containing the body to parse.
-//	req - the interface to populate with the parsed request body.
-//
-// Returns:
-//
-//	bool - true if parsing and validation succeed, false otherwise.
-func (c *OrganizationsController) parseAndValidate(w http.ResponseWriter, r *http.Request, req interface{}) bool {
-	if err := c.validator.ParseRequestBody(r, r.Body, req); err != nil {
-		c.logger.Log(logger.Error, shared_types.ErrFailedToDecodeRequest.Error(), err.Error())
-		utils.SendErrorResponse(w, shared_types.ErrFailedToDecodeRequest.Error(), http.StatusBadRequest)
-		return false
-	}
-
-	if err := c.validator.ValidateRequest(req); err != nil {
-		c.logger.Log(logger.Error, err.Error(), err.Error())
-		utils.SendErrorResponse(w, err.Error(), http.StatusBadRequest)
-		return false
-	}
-
-	return true
-}
-
 // Notify sends a notification to the user for the given payload type.
 //
 // This method constructs a new NotificationPayload object with the given user and request data,

api/internal/features/organization/controller/init.go

@@ -82,14 +82,16 @@ func (router *Router) Routes() {
 	)
 
 	apiV1 := api.NewVersion(api.CurrentVersion)
+
 	healthGroup := fuego.Group(server, apiV1.Path+"/health")
 	router.BasicRoutes(healthGroup)
 
 	notificationManager := notification.NewNotificationManager(router.app.Store.DB)
 	notificationManager.Start()
 	deployController := deploy.NewDeployController(router.app.Store, router.app.Ctx, l, notificationManager)
 
-	fuego.Post(server, "/webhook/", deployController.HandleGithubWebhook)
+	webhookGroup := fuego.Group(server, apiV1.Path+"/webhook")
+	fuego.Post(webhookGroup, "", deployController.HandleGithubWebhook)
 
 	router.WebSocketServer(server, deployController)
 
@@ -120,18 +122,16 @@ func (router *Router) Routes() {
 		return middleware.AuditMiddleware(next, router.app, l)
 	})
 
-	apiV1Group := fuego.Group(server, apiV1.Path)
-
 	authProtectedGroup := fuego.Group(server, apiV1.Path+"/auth")
 	router.AuthenticatedAuthRoutes(authProtectedGroup, authController)
 
 	userController := user.NewUserController(router.app.Store, router.app.Ctx, l)
-	userGroup := fuego.Group(apiV1Group, "/user")
+	userGroup := fuego.Group(server, apiV1.Path+"/user")
 	router.UserRoutes(userGroup, userController)
 
 	domainController := domain.NewDomainsController(router.app.Store, router.app.Ctx, l, notificationManager)
-	domainGroup := fuego.Group(apiV1Group, "/domain")
-	domainsAllGroup := fuego.Group(apiV1Group, "/domains")
+	domainGroup := fuego.Group(server, apiV1.Path+"/domain")
+	domainsAllGroup := fuego.Group(server, apiV1.Path+"/domains")
 	fuego.Use(domainGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "domain")
 	})
@@ -141,49 +141,49 @@ func (router *Router) Routes() {
 	router.DomainRoutes(domainGroup, domainsAllGroup, domainController)
 
 	githubConnectorController := githubConnector.NewGithubConnectorController(router.app.Store, router.app.Ctx, l, notificationManager)
-	githubConnectorGroup := fuego.Group(apiV1Group, "/github-connector")
+	githubConnectorGroup := fuego.Group(server, apiV1.Path+"/github-connector")
 	fuego.Use(githubConnectorGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "github-connector")
 	})
 	router.GithubConnectorRoutes(githubConnectorGroup, githubConnectorController)
 
 	notifController := notificationController.NewNotificationController(router.app.Store, router.app.Ctx, l, notificationManager)
-	notificationGroup := fuego.Group(apiV1Group, "/notification")
+	notificationGroup := fuego.Group(server, apiV1.Path+"/notification")
 	fuego.Use(notificationGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "notification")
 	})
 	router.NotificationRoutes(notificationGroup, notifController)
 
 	organizationController := organization.NewOrganizationsController(router.app.Store, router.app.Ctx, l, notificationManager)
-	organizationGroup := fuego.Group(apiV1Group, "/organizations")
+	organizationGroup := fuego.Group(server, apiV1.Path+"/organizations")
 	fuego.Use(organizationGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "organization")
 	})
 	router.OrganizationRoutes(organizationGroup, organizationController)
 
 	fileManagerController := file_manager.NewFileManagerController(router.app.Ctx, l, notificationManager)
-	fileManagerGroup := fuego.Group(apiV1Group, "/file-manager")
+	fileManagerGroup := fuego.Group(server, apiV1.Path+"/file-manager")
 	fuego.Use(fileManagerGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "file-manager")
 	})
 	router.FileManagerRoutes(fileManagerGroup, fileManagerController)
 
-	deployGroup := fuego.Group(apiV1Group, "/deploy")
+	deployGroup := fuego.Group(server, apiV1.Path+"/deploy")
 	fuego.Use(deployGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "deploy")
 	})
 	router.DeployRoutes(deployGroup, deployController)
 
 	auditController := audit.NewAuditController(router.app.Store.DB, router.app.Ctx, l)
-	auditGroup := fuego.Group(apiV1Group, "/audit")
+	auditGroup := fuego.Group(server, apiV1.Path+"/audit")
 	fuego.Use(auditGroup, func(next http.Handler) http.Handler {
 		return middleware.RBACMiddleware(next, router.app, "audit")
 	})
 	router.AuditRoutes(auditGroup, auditController)
 
 	updateService := update_service.NewUpdateService(router.app, &l, router.app.Ctx)
 	updateController := update.NewUpdateController(updateService, &l)
-	updateGroup := fuego.Group(apiV1Group, "/update")
+	updateGroup := fuego.Group(server, apiV1.Path+"/update")
 	router.UpdateRoutes(updateGroup, updateController)
 
 	server.Run()

api/internal/routes.go

@@ -1 +1,5 @@
 node_modules
+.cache
+dist
+.vitepress/dist/
+.vitepress/cache