PolicyRule

Fields

A single rule within a release gate policy.

5 fields

enabled

boolean

id · required

string

name · required

string

params

object

type · required

string

Raw schema (JSON)

{
  "description": "A single rule within a release gate policy.",
  "properties": {
    "enabled": {
      "default": true,
      "title": "Enabled",
      "type": "boolean"
    },
    "id": {
      "maxLength": 100,
      "minLength": 1,
      "title": "Id",
      "type": "string"
    },
    "name": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Name",
      "type": "string"
    },
    "params": {
      "additionalProperties": true,
      "title": "Params",
      "type": "object"
    },
    "type": {
      "title": "Type",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "type"
  ],
  "title": "PolicyRule",
  "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

• PolicyDocument

More details

• Specification: OpenAPI JSON