add relations

Author: jsbroks

apps/workspace-engine/oapi/spec.yaml

@@ -162,6 +162,42 @@ paths:
               schema:
                 $ref: "#/components/schemas/NotFoundError"
 
+  /v1/workspaces/{workspaceId}/entities/{entityType}/{entityId}/relationships:
+    get:
+      summary: Get related entities for a given entity
+      operationId: getRelatedEntities
+      description: Returns all entities related to the specified entity (deployment, environment, or resource) based on relationship rules. Relationships are grouped by relationship reference.
+      parameters:
+        - $ref: "#/components/parameters/workspaceId"
+        - $ref: "#/components/parameters/entityType"
+        - $ref: "#/components/parameters/entityId"
+      responses:
+        "200":
+          description: Related entities grouped by relationship reference.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  relationships:
+                    type: object
+                    additionalProperties:
+                      type: array
+                      items:
+                        $ref: "#/components/schemas/RelatedEntityGroup"
+        "404":
+          description: Entity not found.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotFoundError"
+        "400":
+          description: Invalid entity type.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotFoundError"
+
 components:
   parameters:
     policyId:
@@ -206,6 +242,24 @@ components:
       description: ID of the release target.
       schema:
         type: string
+    entityType:
+      name: entityType
+      in: path
+      required: true
+      description: Type of the entity (deployment, environment, or resource).
+      schema:
+        type: string
+        enum:
+          - deployment
+          - environment
+          - resource
+    entityId:
+      name: entityId
+      in: path
+      required: true
+      description: ID of the entity.
+      schema:
+        type: string
   schemas:
     DeployDecision:
       type: object
@@ -834,6 +888,12 @@ components:
           items:
             $ref: "#/components/schemas/PropertyMatcher"
 
+    RelationDirection:
+      type: string
+      enum:
+        - from
+        - to
+
     RelationshipRule:
       type: object
       required:
@@ -856,11 +916,11 @@ components:
         reference:
           type: string
         fromType:
-          type: string
+          $ref: "#/components/schemas/RelatableEntityType"
         fromSelector:
           $ref: "#/components/schemas/Selector"
         toType:
-          type: string
+          $ref: "#/components/schemas/RelatableEntityType"
         toSelector:
           $ref: "#/components/schemas/Selector"
         matcher:
@@ -876,6 +936,40 @@ components:
         workspaceId:
           type: string
 
+    RelatedEntityGroup:
+      type: object
+      required:
+        - relationshipRule
+        - direction
+        - entityType
+        - entityId
+        - entity
+      properties:
+        rule:
+          $ref: "#/components/schemas/RelationshipRule"
+        direction:
+          $ref: "#/components/schemas/RelationDirection"
+        entityType:
+          $ref: "#/components/schemas/RelatableEntityType"
+        entityId:
+          type: string
+          description: ID of the related entity
+        entity:
+          $ref: "#/components/schemas/RelatableEntity"
+
+    RelatableEntity:
+      oneOf:
+        - $ref: "#/components/schemas/Deployment"
+        - $ref: "#/components/schemas/Environment"
+        - $ref: "#/components/schemas/Resource"
+
+    RelatableEntityType:
+      type: string
+      enum:
+        - deployment
+        - environment
+        - resource
+
     EvaluateReleaseTargetRequest:
       type: object
       required:

apps/workspace-engine/pkg/oapi/entity.go

@@ -0,0 +1,83 @@
+package oapi
+
+import "encoding/json"
+
+func (e *RelatableEntity) GetType() RelatableEntityType {
+	// Try to unmarshal into a map to check for distinguishing fields
+	var data map[string]any
+	if err := json.Unmarshal(e.union, &data); err != nil {
+		return ""
+	}
+
+	// Check for distinguishing fields
+	// Deployment has "slug" field
+	if _, hasSlug := data["slug"]; hasSlug {
+		return "deployment"
+	}
+
+	// Resource has "kind" field
+	if _, hasKind := data["kind"]; hasKind {
+		return "resource"
+	}
+
+	// Environment has "systemId" but no "slug" or "kind"
+	if _, hasSystemId := data["systemId"]; hasSystemId {
+		return "environment"
+	}
+
+	return ""
+}
+
+func (e *RelatableEntity) GetDeployment() *Deployment {
+	if e.GetType() == "deployment" {
+		deployment, err := e.AsDeployment()
+		if err != nil {
+			return nil
+		}
+		return &deployment
+	}
+	return nil
+}
+
+func (e *RelatableEntity) GetEnvironment() *Environment {
+	if e.GetType() == "environment" {
+		environment, err := e.AsEnvironment()
+		if err != nil {
+			return nil
+		}
+		return &environment
+	}
+	return nil
+}
+
+func (e *RelatableEntity) GetResource() *Resource {
+	if e.GetType() == "resource" {
+		resource, err := e.AsResource()
+		if err != nil {
+			return nil
+		}
+		return &resource
+	}
+	return nil
+}
+
+func (e *RelatableEntity) GetID() string {
+	switch e.GetType() {
+	case "deployment":
+		d := e.GetDeployment()
+		if d != nil {
+			return d.Id
+		}
+	case "environment":
+		env := e.GetEnvironment()
+		if env != nil {
+			return env.Id
+		}
+	case "resource":
+		r := e.GetResource()
+		if r != nil {
+			return r.Id
+		}
+	}
+	return ""
+}