Merge pull request #73 from thivindu/platform-api

Implement list gateways that a API is deployed and artifacts that are deployed in a Gateway

Author: thivindu

platform-api/spec/impls/api-lifecycle-management.md

@@ -2,10 +2,11 @@
 
 ## Entry Points
 
-- `platform-api/src/internal/handler/api.go` – implements `/api/v1/apis` CRUD, `/api/v1/projects/:projectId/apis` listing routes and `/api/v1/apis/:apiId/deploy-revision` for API deployment
-- `platform-api/src/internal/service/api.go` – validates names, contexts, versions, orchestrates default values and generates deployment YAML and deploys APIs in the Gateway plus repository calls.
+- `platform-api/src/internal/handler/api.go` – implements `/api/v1/apis` CRUD, `/api/v1/projects/:projectId/apis` listing routes, `/api/v1/apis/:apiId/deploy-revision` for API deployment, and `/api/v1/apis/:apiId/gateways` for retrieving deployment status
+- `platform-api/src/internal/service/api.go` – validates names, contexts, versions, orchestrates default values and generates deployment YAML and deploys APIs in the Gateway plus repository calls. Also handles gateway deployment queries.
 - `platform-api/src/internal/repository/api.go` – persists APIs, security, CORS, backend services, rate limiting, and operations using transactions.
-- `platform-api/src/internal/database/schema.sql` – contains tables for APIs, security configs, backend services, rate limits, and operations.
+- `platform-api/src/internal/repository/gateway.go` – handles gateway operations including querying which gateways have specific APIs deployed.
+- `platform-api/src/internal/database/schema.sql` – contains tables for APIs, security configs, backend services, rate limits, operations, and API deployments tracking.
 - `platform-api/src/resources/openapi.yaml` – provides the published API lifecycle contract for client integrations.
 
 ## Behaviour
@@ -14,10 +15,15 @@
 2. Repository layer writes the main API record and related configuration tables within a single transaction.
 3. GET routes return fully hydrated API structures, including nested security and backend definitions.
 4. Update requests replace mutable fields and rebuild related configuration sets; deletes cascade via foreign keys.
-5. Generates comprehensive deployment API YAML including:
+5. Gateway deployment tracking uses the `api_deployments` table to maintain relationships between APIs and gateways.
+6. The gateways endpoint queries deployed APIs by joining API deployments with gateway records, filtered by organization for security.
+7. Generates comprehensive deployment API YAML including:
     - API metadata and configuration
     - Security policies (mTLS, OAuth2, API Key)
+
+## Verification
 - Create: `curl -k -X POST https://localhost:8443/api/v1/apis -H 'Content-Type: application/json' -d '{"name":"inventory","context":"/inventory","version":"v1","projectId":"<projectId>"}'`.
 - Fetch: `curl -k https://localhost:8443/api/v1/apis/<apiId>`; confirm nested structures.
 - List: `curl -k https://localhost:8443/api/v1/projects/<projectId>/apis` to verify pagination metadata and entries.
 - Deploy API: `curl -k -X POST https://localhost:8443/api/v1/apis/<apiId>/deploy-revision -H 'Content-Type: application/json' -d '[{"name": "production-deployment","gatewayId": "987e6543-e21b-45d3-a789-426614174999", "displayOnDevportal": true}]'` to trigger API deployment.
+- Get API Gateways: `curl -k https://localhost:8443/api/v1/apis/<apiId>/gateways` to retrieve all gateways where the API is deployed; expect JSON array with gateway details (id, name, displayName, vhost, isActive, etc.).

platform-api/spec/impls/gateway-management/gateway-management.md

@@ -29,6 +29,7 @@ Gateway Management provides APIs for registering, managing, and deleting API gat
 | PUT | `/api/v1/gateways/{id}` | Update gateway | ✅ Implemented |
 | DELETE | `/api/v1/gateways/{id}` | Delete gateway | ✅ Implemented |
 | POST | `/api/v1/gateways/{id}/tokens` | Rotate gateway token | ✅ Implemented |
+| GET | `/api/v1/gateways/{id}/live-proxy-artifacts` | Get deployed artifacts | ✅ Implemented |
 | DELETE | `/api/v1/gateways/{id}/tokens/{tokenId}` | Revoke token | ⏳ Planned |
 
 ## Authentication & Authorization

platform-api/src/internal/constants/constants.go

@@ -64,3 +64,39 @@ var ValidGatewayFunctionalityType = map[string]bool{
 
 // DefaultGatewayFunctionalityType Default gateway functionality type for new gateways
 const DefaultGatewayFunctionalityType = GatewayFunctionalityTypeRegular
+
+// API Type Constants
+const (
+	APITypeHTTP       = "HTTP"
+	APITypeWS         = "WS"
+	APITypeSOAPToREST = "SOAPTOREST"
+	APITypeSOAP       = "SOAP"
+	APITypeGraphQL    = "GRAPHQL"
+	APITypeWebSub     = "WEBSUB"
+	APITypeSSE        = "SSE"
+	APITypeWebhook    = "WEBHOOK"
+	APITypeAsync      = "ASYNC"
+)
+
+// API SubType Constants
+const (
+	APISubTypeHTTP      = "REST"
+	APISubTypeGraphQL   = "GQL"
+	APISubTypeAsync     = "ASYNC"
+	APISubTypeWebSocket = "WEBSOCKET"
+	APISubTypeSOAP      = "SOAP"
+)
+
+// Artifact Type Constants
+const (
+	ArtifactTypeAPI        = "API"
+	ArtifactTypeMCP        = "MCP"
+	ArtifactTypeAPIProduct = "API_PRODUCT"
+)
+
+// ValidArtifactTypes Valid artifact types deployed to gateways
+var ValidArtifactTypes = map[string]bool{
+	ArtifactTypeAPI:        true,
+	ArtifactTypeMCP:        true,
+	ArtifactTypeAPIProduct: true,
+}

platform-api/src/internal/dto/gateway.go

@@ -90,3 +90,21 @@ type GatewayStatusListResponse struct {
 	List       []GatewayStatusResponse `json:"list"`
 	Pagination Pagination              `json:"pagination"`
 }
+
+// GatewayArtifact represents an artifact (API, MCP, API Product) deployed to a gateway
+type GatewayArtifact struct {
+	ID          string    `json:"id"`
+	Name        string    `json:"name"`
+	DisplayName string    `json:"displayName,omitempty"`
+	Type        string    `json:"type"`              // "API", "MCP", "API_PRODUCT"
+	SubType     string    `json:"subType,omitempty"` // For APIs: "REST", "ASYNC", "GQL"
+	CreatedAt   time.Time `json:"createdAt"`
+	UpdatedAt   time.Time `json:"updatedAt"`
+}
+
+// GatewayArtifactListResponse represents a paginated list of artifacts deployed to a gateway
+type GatewayArtifactListResponse struct {
+	Count      int               `json:"count"`
+	List       []GatewayArtifact `json:"list"`
+	Pagination Pagination        `json:"pagination"`
+}

platform-api/src/internal/handler/api.go

@@ -19,15 +19,14 @@ package handler
 
 import (
 	"errors"
+	"github.com/gin-gonic/gin"
 	"log"
 	"net/http"
 	"platform-api/src/internal/constants"
 	"platform-api/src/internal/dto"
 	"platform-api/src/internal/middleware"
 	"platform-api/src/internal/service"
 	"platform-api/src/internal/utils"
-
-	"github.com/gin-gonic/gin"
 )
 
 type APIHandler struct {
@@ -340,6 +339,36 @@ func (h *APIHandler) DeployAPIRevision(c *gin.Context) {
 	c.JSON(http.StatusOK, deployments)
 }
 
+// GetAPIDeployedGateways handles GET /api/v1/apis/{apiId}/gateways
+func (h *APIHandler) GetAPIDeployedGateways(c *gin.Context) {
+	orgId, exists := middleware.GetOrganizationFromContext(c)
+	if !exists {
+		c.JSON(http.StatusUnauthorized, utils.NewErrorResponse(401, "Unauthorized",
+			"Organization claim not found in token"))
+		return
+	}
+
+	apiId := c.Param("apiId")
+	if apiId == "" {
+		c.JSON(http.StatusBadRequest, utils.NewErrorResponse(400, "Bad Request", "API ID is required"))
+		return
+	}
+
+	// Get paginated gateways for the API
+	gatewayListResponse, err := h.apiService.GetGatewaysForAPI(apiId, orgId)
+	if err != nil {
+		if errors.Is(err, constants.ErrAPINotFound) {
+			c.JSON(http.StatusNotFound, utils.NewErrorResponse(404, "Not Found", "API not found"))
+			return
+		}
+		c.JSON(http.StatusInternalServerError, utils.NewErrorResponse(500, "Internal Server Error", "Failed to get API gateways"))
+		return
+	}
+
+	// Return paginated gateway list
+	c.JSON(http.StatusOK, gatewayListResponse)
+}
+
 // RegisterRoutes registers all API routes
 func (h *APIHandler) RegisterRoutes(r *gin.Engine) {
 	// API routes
@@ -351,5 +380,6 @@ func (h *APIHandler) RegisterRoutes(r *gin.Engine) {
 		apiGroup.PUT("/:apiId", h.UpdateAPI)
 		apiGroup.DELETE("/:apiId", h.DeleteAPI)
 		apiGroup.POST("/:apiId/deploy-revision", h.DeployAPIRevision)
+		apiGroup.GET("/:apiId/gateways", h.GetAPIDeployedGateways)
 	}
 }

platform-api/src/internal/handler/gateway.go

@@ -321,6 +321,51 @@ func (h *GatewayHandler) RotateToken(c *gin.Context) {
 	c.JSON(http.StatusCreated, response)
 }
 
+// GetGatewayArtifacts handles GET /api/v1/gateways/{gatewayId}/live-proxy-artifacts
+func (h *GatewayHandler) GetGatewayArtifacts(c *gin.Context) {
+	orgId, exists := middleware.GetOrganizationFromContext(c)
+	if !exists {
+		c.JSON(http.StatusUnauthorized, utils.NewErrorResponse(401, "Unauthorized",
+			"Organization claim not found in token"))
+		return
+	}
+
+	gatewayId := c.Param("gatewayId")
+	if gatewayId == "" {
+		c.JSON(http.StatusBadRequest, utils.NewErrorResponse(400, "Bad Request",
+			"Gateway ID is required"))
+		return
+	}
+
+	// Parse artifact type filter parameter
+	artifactType := c.Query("artifactType")
+	// Validate artifactType if provided
+	if artifactType != "" {
+		if !constants.ValidArtifactTypes[artifactType] {
+			c.JSON(http.StatusBadRequest, utils.NewErrorResponse(400, "Bad Request",
+				"Invalid artifact type. Valid values are: "+constants.ArtifactTypeAPI+", "+constants.ArtifactTypeMCP+
+					", "+constants.ArtifactTypeAPIProduct))
+			return
+		}
+	}
+
+	// Get paginated artifacts for the gateway
+	artifactListResponse, err := h.gatewayService.GetGatewayArtifacts(gatewayId, orgId, artifactType)
+	if err != nil {
+		if errors.Is(err, constants.ErrGatewayNotFound) {
+			c.JSON(http.StatusNotFound, utils.NewErrorResponse(404, "Not Found",
+				"Gateway not found"))
+			return
+		}
+		c.JSON(http.StatusInternalServerError, utils.NewErrorResponse(500, "Internal Server Error",
+			"Failed to get gateway artifacts"))
+		return
+	}
+
+	// Return paginated artifact list
+	c.JSON(http.StatusOK, artifactListResponse)
+}
+
 // RegisterRoutes registers gateway routes with the router
 func (h *GatewayHandler) RegisterRoutes(r *gin.Engine) {
 	gatewayGroup := r.Group("/api/v1/gateways")
@@ -331,6 +376,7 @@ func (h *GatewayHandler) RegisterRoutes(r *gin.Engine) {
 		gatewayGroup.PUT("/:gatewayId", h.UpdateGateway)
 		gatewayGroup.DELETE("/:gatewayId", h.DeleteGateway)
 		gatewayGroup.POST("/:gatewayId/tokens", h.RotateToken)
+		gatewayGroup.GET("/:gatewayId/live-proxy-artifacts", h.GetGatewayArtifacts)
 	}
 
 	gatewayStatusGroup := r.Group("/api/v1/status")

platform-api/src/internal/repository/api.go

@@ -266,6 +266,37 @@ func (r *APIRepo) GetAPIsByOrganizationID(orgID string, projectID *string) ([]*m
 	return apis, rows.Err()
 }
 
+// GetAPIsByGatewayID retrieves all APIs deployed to a specific gateway
+func (r *APIRepo) GetAPIsByGatewayID(gatewayID, organizationID string) ([]*model.API, error) {
+	query := `
+		SELECT a.uuid, a.name, a.display_name, a.type, a.created_at, a.updated_at
+		FROM apis a
+		INNER JOIN api_deployments ad ON a.uuid = ad.api_uuid
+		WHERE ad.gateway_uuid = ? AND a.organization_uuid = ?
+		ORDER BY a.created_at DESC
+	`
+
+	rows, err := r.db.Query(query, gatewayID, organizationID)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+
+	var apis []*model.API
+	for rows.Next() {
+		api := &model.API{}
+		err := rows.Scan(
+			&api.ID, &api.Name, &api.DisplayName, &api.Type, &api.CreatedAt, &api.UpdatedAt,
+		)
+		if err != nil {
+			return nil, err
+		}
+		apis = append(apis, api)
+	}
+
+	return apis, nil
+}
+
 // UpdateAPI modifies an existing API
 func (r *APIRepo) UpdateAPI(api *model.API) error {
 	tx, err := r.db.Begin()

platform-api/src/internal/repository/gateway.go

@@ -287,3 +287,36 @@ func (r *GatewayRepo) CountActiveTokens(gatewayId string) (int, error) {
 	err := r.db.QueryRow(query, gatewayId).Scan(&count)
 	return count, err
 }
+
+// GetGatewaysByAPIID retrieves all gateways where the specified API is deployed
+func (r *GatewayRepo) GetGatewaysByAPIID(apiID, organizationID string) ([]*model.Gateway, error) {
+	query := `
+		SELECT g.uuid, g.organization_uuid, g.name, g.display_name, g.description, 
+		       g.vhost, g.is_critical, g.gateway_functionality_type, g.is_active, 
+		       g.created_at, g.updated_at
+		FROM gateways g
+		INNER JOIN api_deployments ad ON g.uuid = ad.gateway_uuid
+		WHERE ad.api_uuid = ? AND g.organization_uuid = ?
+		ORDER BY g.created_at DESC
+	`
+	rows, err := r.db.Query(query, apiID, organizationID)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+
+	var gateways []*model.Gateway
+	for rows.Next() {
+		gateway := &model.Gateway{}
+		err := rows.Scan(
+			&gateway.ID, &gateway.OrganizationID, &gateway.Name, &gateway.DisplayName,
+			&gateway.Description, &gateway.Vhost, &gateway.IsCritical,
+			&gateway.FunctionalityType, &gateway.IsActive, &gateway.CreatedAt, &gateway.UpdatedAt,
+		)
+		if err != nil {
+			return nil, err
+		}
+		gateways = append(gateways, gateway)
+	}
+	return gateways, nil
+}

platform-api/src/internal/repository/interfaces.go

@@ -48,6 +48,7 @@ type APIRepository interface {
 	GetAPIByUUID(apiId string) (*model.API, error)
 	GetAPIsByProjectID(projectID string) ([]*model.API, error)
 	GetAPIsByOrganizationID(orgID string, projectID *string) ([]*model.API, error)
+	GetAPIsByGatewayID(gatewayID, organizationID string) ([]*model.API, error)
 	UpdateAPI(api *model.API) error
 	DeleteAPI(apiId string) error
 	CreateDeployment(deployment *model.APIDeployment) error
@@ -61,6 +62,7 @@ type GatewayRepository interface {
 	GetByUUID(gatewayId string) (*model.Gateway, error)
 	GetByOrganizationID(orgID string) ([]*model.Gateway, error)
 	GetByNameAndOrgID(name, orgID string) (*model.Gateway, error)
+	GetGatewaysByAPIID(apiID, organizationID string) ([]*model.Gateway, error)
 	List() ([]*model.Gateway, error)
 	Delete(gatewayID, organizationID string) error
 	UpdateGateway(gateway *model.Gateway) error

platform-api/src/internal/server/server.go

@@ -84,7 +84,7 @@ func StartPlatformAPIServer(cfg *config.Server) (*Server, error) {
 	projectService := service.NewProjectService(projectRepo, orgRepo, apiRepo)
 	gatewayEventsService := service.NewGatewayEventsService(wsManager)
 	apiService := service.NewAPIService(apiRepo, projectRepo, gatewayRepo, gatewayEventsService)
-	gatewayService := service.NewGatewayService(gatewayRepo, orgRepo)
+	gatewayService := service.NewGatewayService(gatewayRepo, orgRepo, apiRepo)
 	internalGatewayService := service.NewGatewayInternalAPIService(apiRepo, gatewayRepo, orgRepo)
 
 	// Initialize handlers