PolicyDocument

Fields

The full policy rule document stored as JSON in release_gate_policies.rules.

7 fields

dimension_weights: PolicyDimensionWeights
hard_caps: PolicyHardCaps
kind_rules: PolicyKindRules
pass_rate_bands: PolicyPassRateBands
rules: array of PolicyRule
schema_version: integer
thresholds: PolicyThresholds

Raw schema (JSON)

{
  "description": "The full policy rule document stored as JSON in release_gate_policies.rules.",
  "properties": {
    "dimension_weights": {
      "$ref": "#/components/schemas/PolicyDimensionWeights"
    },
    "hard_caps": {
      "$ref": "#/components/schemas/PolicyHardCaps"
    },
    "kind_rules": {
      "$ref": "#/components/schemas/PolicyKindRules"
    },
    "pass_rate_bands": {
      "$ref": "#/components/schemas/PolicyPassRateBands"
    },
    "rules": {
      "items": {
        "$ref": "#/components/schemas/PolicyRule"
      },
      "title": "Rules",
      "type": "array"
    },
    "schema_version": {
      "default": 1,
      "title": "Schema Version",
      "type": "integer"
    },
    "thresholds": {
      "$ref": "#/components/schemas/PolicyThresholds"
    }
  },
  "title": "PolicyDocument",
  "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 — Create Policy
PATCH /api/v1/release-gate-policies/{policy_id} — Update Policy
POST /api/v1/release-gate-policies/simulate — Simulate Policy

Used by schemas

More details

Specification: OpenAPI JSON