Get gateways that a API is deployed

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/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/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

@@ -61,6 +61,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/service/api.go

@@ -433,6 +433,58 @@ func (s *APIService) DeployAPIRevision(apiId string, revisionID string,
 	return deployments, nil
 }
 
+// GetGatewaysForAPI retrieves all gateways where the specified API is deployed with pagination
+func (s *APIService) GetGatewaysForAPI(apiId, orgId string) (*dto.GatewayListResponse, error) {
+	// First validate that the API exists and belongs to the organization
+	apiModel, err := s.apiRepo.GetAPIByUUID(apiId)
+	if err != nil {
+		return nil, err
+	}
+	if apiModel == nil {
+		return nil, constants.ErrAPINotFound
+	}
+	if apiModel.OrganizationID != orgId {
+		return nil, constants.ErrAPINotFound
+	}
+
+	// Get all gateways where this API is deployed (without pagination for total count)
+	gateways, err := s.gatewayRepo.GetGatewaysByAPIID(apiId, orgId)
+	if err != nil {
+		return nil, err
+	}
+
+	// Convert models to DTOs
+	responses := make([]dto.GatewayResponse, 0, len(gateways))
+	for _, gw := range gateways {
+		responses = append(responses, dto.GatewayResponse{
+			ID:                gw.ID,
+			OrganizationID:    gw.OrganizationID,
+			Name:              gw.Name,
+			DisplayName:       gw.DisplayName,
+			Description:       gw.Description,
+			Vhost:             gw.Vhost,
+			IsCritical:        gw.IsCritical,
+			FunctionalityType: gw.FunctionalityType,
+			IsActive:          gw.IsActive,
+			CreatedAt:         gw.CreatedAt,
+			UpdatedAt:         gw.UpdatedAt,
+		})
+	}
+
+	// Create paginated response
+	listResponse := &dto.GatewayListResponse{
+		Count: len(responses),
+		List:  responses,
+		Pagination: dto.Pagination{
+			Total:  len(responses), // For now, total equals count (no pagination yet)
+			Offset: 0,              // Starting from first item
+			Limit:  len(responses), // Returning all items
+		},
+	}
+
+	return listResponse, nil
+}
+
 // validateDeploymentRequest validates the deployment request
 func (s *APIService) validateDeploymentRequest(req *dto.APIRevisionDeployment, orgId string) error {
 	if req.GatewayID == "" {

platform-api/src/resources/openapi.yaml

@@ -413,6 +413,35 @@ paths:
         '500':
           $ref: '#/components/responses/InternalServerError'
 
+  /apis/{apiId}/gateways:
+    get:
+      summary: Get gateways for API
+      description: |
+        Retrieves all gateways where the specified API is deployed with pagination support. 
+        This endpoint returns a paginated list of gateway instances that currently have the API deployed to them.
+        Access is validated against the organization in the JWT token.
+      operationId: GetAPIGateways
+      tags:
+        - APIs
+        - Gateways
+      parameters:
+        - $ref: '#/components/parameters/apiID'
+      responses:
+        '200':
+          description: Paginated list of gateways where the API is deployed
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GatewayListResponse'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+
   /gateways:
     post:
       summary: Register a new gateway