RuleEvaluationResponse

Fields

Result of evaluating a single policy rule.

8 fields

action · required: string
actual_value: number or null
message · required: string
passed · required: boolean
rule_id · required: string
rule_name · required: string
rule_type · required: string
threshold_value: number or null

Raw schema (JSON)

{
  "description": "Result of evaluating a single policy rule.",
  "properties": {
    "action": {
      "title": "Action",
      "type": "string"
    },
    "actual_value": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Actual Value"
    },
    "message": {
      "title": "Message",
      "type": "string"
    },
    "passed": {
      "title": "Passed",
      "type": "boolean"
    },
    "rule_id": {
      "title": "Rule Id",
      "type": "string"
    },
    "rule_name": {
      "title": "Rule Name",
      "type": "string"
    },
    "rule_type": {
      "title": "Rule Type",
      "type": "string"
    },
    "threshold_value": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Threshold Value"
    }
  },
  "required": [
    "rule_id",
    "rule_name",
    "rule_type",
    "passed",
    "action",
    "message"
  ],
  "title": "RuleEvaluationResponse",
  "type": "object"
}

Used by endpoints

3 endpoints send or return this schema, on its own or inside another schema.

POST /api/v1/release-gate-policies/simulate — Simulate Policy
GET /api/v1/release-readiness/{run_id} — Get Release Decision
POST /api/v1/release-readiness/{run_id}/override — Override Release Decision

Used by schemas

More details

Specification: OpenAPI JSON