chore: add rule id to deploydecision and get rules oapi

Author: adityachoudhari26

apps/workspace-engine/oapi/openapi.json

@@ -1137,9 +1137,14 @@
                "message": {
                   "description": "Human-readable explanation of the rule result",
                   "type": "string"
+               },
+               "ruleId": {
+                  "description": "The ID of the rule that was evaluated",
+                  "type": "string"
                }
             },
             "required": [
+               "ruleId",
                "allowed",
                "actionRequired",
                "message",
@@ -3136,6 +3141,74 @@
             "summary": "Get release targets for a policy"
          }
       },
+      "/v1/workspaces/{workspaceId}/policies/{policyId}/rules/{ruleId}": {
+         "get": {
+            "description": "Returns a specific rule by ID.",
+            "operationId": "getRule",
+            "parameters": [
+               {
+                  "description": "ID of the workspace",
+                  "in": "path",
+                  "name": "workspaceId",
+                  "required": true,
+                  "schema": {
+                     "type": "string"
+                  }
+               },
+               {
+                  "description": "ID of the policy",
+                  "in": "path",
+                  "name": "policyId",
+                  "required": true,
+                  "schema": {
+                     "type": "string"
+                  }
+               },
+               {
+                  "description": "ID of the rule",
+                  "in": "path",
+                  "name": "ruleId",
+                  "required": true,
+                  "schema": {
+                     "type": "string"
+                  }
+               }
+            ],
+            "responses": {
+               "200": {
+                  "content": {
+                     "application/json": {
+                        "schema": {
+                           "$ref": "#/components/schemas/PolicyRule"
+                        }
+                     }
+                  },
+                  "description": "OK response"
+               },
+               "400": {
+                  "content": {
+                     "application/json": {
+                        "schema": {
+                           "$ref": "#/components/schemas/ErrorResponse"
+                        }
+                     }
+                  },
+                  "description": "Invalid request"
+               },
+               "404": {
+                  "content": {
+                     "application/json": {
+                        "schema": {
+                           "$ref": "#/components/schemas/ErrorResponse"
+                        }
+                     }
+                  },
+                  "description": "Resource not found"
+               }
+            },
+            "summary": "Get rule"
+         }
+      },
       "/v1/workspaces/{workspaceId}/relationship-rules": {
          "get": {
             "description": "Returns all relationship rules for the specified workspace.",

apps/workspace-engine/oapi/spec/lib/openapi.libsonnet

@@ -19,6 +19,7 @@
   // Common parameters
   workspaceIdParam():: self.stringParam('workspaceId', 'ID of the workspace'),
   policyIdParam():: self.stringParam('policyId', 'ID of the policy'),
+  ruleIdParam():: self.stringParam('ruleId', 'ID of the rule'),
   resourceIdParam():: self.stringParam('resourceId', 'ID of the resource'),
   resourceIdentifierParam():: self.stringParam('resourceIdentifier', 'Identifier of the resource'),
   deploymentIdParam():: self.stringParam('deploymentId', 'ID of the deployment'),

apps/workspace-engine/oapi/spec/paths/policy.jsonnet

@@ -65,4 +65,20 @@ local openapi = import '../lib/openapi.libsonnet';
       ) + openapi.notFoundResponse(),
     },
   },
+
+  '/v1/workspaces/{workspaceId}/policies/{policyId}/rules/{ruleId}': {
+    get: {
+      summary: 'Get rule',
+      operationId: 'getRule',
+      description: 'Returns a specific rule by ID.',
+      parameters: [
+        openapi.workspaceIdParam(),
+        openapi.policyIdParam(),
+        openapi.ruleIdParam(),
+      ],
+      responses: openapi.okResponse(openapi.schemaRef('PolicyRule'))
+                 + openapi.notFoundResponse()
+                 + openapi.badRequestResponse(),
+    },
+  },
 }

apps/workspace-engine/oapi/spec/schemas/policy.jsonnet

@@ -137,8 +137,12 @@ local openapi = import '../lib/openapi.libsonnet';
 
   RuleEvaluation: {
     type: 'object',
-    required: ['allowed', 'actionRequired', 'message', 'details'],
+    required: ['ruleId', 'allowed', 'actionRequired', 'message', 'details'],
     properties: {
+      ruleId: {
+        type: 'string',
+        description: 'The ID of the rule that was evaluated',
+      },
       allowed: {
         type: 'boolean',
         description: 'Whether the rule allows the deployment',

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

@@ -2,6 +2,7 @@ package oapi
 
 func NewRuleEvaluation() *RuleEvaluation {
 	return &RuleEvaluation{
+		RuleId:         "",
 		Allowed:        false,
 		ActionRequired: false,
 		ActionType:     nil,
@@ -20,6 +21,11 @@ func (r *RuleEvaluation) Deny() *RuleEvaluation {
 	return r
 }
 
+func (r *RuleEvaluation) WithRuleId(ruleId string) *RuleEvaluation {
+	r.RuleId = ruleId
+	return r
+}
+
 func (r *RuleEvaluation) WithActionRequired(actionType RuleEvaluationActionType) *RuleEvaluation {
 	r.ActionRequired = true
 	r.ActionType = &actionType

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

@@ -1,6 +1,7 @@
 package policies
 
 import (
+	"fmt"
 	"net/http"
 	"workspace-engine/pkg/oapi"
 	"workspace-engine/pkg/selector"
@@ -100,3 +101,32 @@ func (p *Policies) GetReleaseTargetsForPolicy(c *gin.Context, workspaceId string
 		"releaseTargets": matchingReleaseTargets,
 	})
 }
+
+func (p *Policies) GetRule(c *gin.Context, workspaceId string, policyId string, ruleId string) {
+	ws, err := utils.GetWorkspace(c, workspaceId)
+	if err != nil {
+		c.JSON(http.StatusInternalServerError, gin.H{
+			"error": "Failed to get workspace: " + err.Error(),
+		})
+		return
+	}
+
+	policy, ok := ws.Policies().Get(policyId)
+	if !ok {
+		c.JSON(http.StatusNotFound, gin.H{
+			"error": "Policy not found",
+		})
+		return
+	}
+
+	for _, rule := range policy.Rules {
+		if rule.Id == ruleId {
+			c.JSON(http.StatusOK, rule)
+			return
+		}
+	}
+
+	c.JSON(http.StatusNotFound, gin.H{
+		"error": fmt.Sprintf("Rule %s not found in policy %s", ruleId, policyId),
+	})
+}

apps/workspace-engine/pkg/server/openapi/policies/policies.go

@@ -39,7 +39,7 @@ func (f *EvaluatorFactory) EvaluateEnvironmentAndVersionAndTargetScopedPolicyRul
 			if err != nil {
 				return nil, err
 			}
-			ruleResults = append(ruleResults, result)
+			ruleResults = append(ruleResults, result.WithRuleId(rule.Id))
 		}
 		return ruleResults, nil
 	})
@@ -62,7 +62,7 @@ func (f *EvaluatorFactory) EvaluateEnvironmentAndVersionScopedPolicyRules(
 			if err != nil {
 				return nil, err
 			}
-			ruleResults = append(ruleResults, result)
+			ruleResults = append(ruleResults, result.WithRuleId(rule.Id))
 		}
 		return ruleResults, nil
 	})
@@ -86,7 +86,7 @@ func (f *EvaluatorFactory) EvaluateVersionScopedPolicyRules(
 			if err != nil {
 				return nil, err
 			}
-			ruleResults = append(ruleResults, result)
+			ruleResults = append(ruleResults, result.WithRuleId(rule.Id))
 		}
 		return ruleResults, nil
 	})
@@ -110,7 +110,7 @@ func (f *EvaluatorFactory) EvaluateTargetScopedPolicyRules(
 			if err != nil {
 				return nil, err
 			}
-			ruleResults = append(ruleResults, result)
+			ruleResults = append(ruleResults, result.WithRuleId(rule.Id))
 		}
 		return ruleResults, nil
 	})
@@ -134,7 +134,7 @@ func (f *EvaluatorFactory) EvaluateReleaseScopedPolicyRules(
 			if err != nil {
 				return nil, err
 			}
-			ruleResults = append(ruleResults, result)
+			ruleResults = append(ruleResults, result.WithRuleId(rule.Id))
 		}
 		return ruleResults, nil
 	})
@@ -157,7 +157,7 @@ func (f *EvaluatorFactory) EvaluateWorkspaceScopedPolicyRules(
 			if err != nil {
 				return nil, err
 			}
-			ruleResults = append(ruleResults, result)
+			ruleResults = append(ruleResults, result.WithRuleId(rule.Id))
 		}
 		return ruleResults, nil
 	})