ReleaseGatePolicyResponse

Fields

Policy summary response.

15 fields

activated_at

string (date-time) or null

activated_by

string (uuid) or null

activated_by_name

string or null

created_at · required

string (date-time)

created_by · required

string (uuid)

created_by_name

string or null

description

string or null

id · required

string (uuid)

is_active · required

boolean

is_draft · required

boolean

name · required

string

project_id

string (uuid) or null

rules · required

object

updated_at

string (date-time) or null

version · required

integer

Raw schema (JSON)

{
  "description": "Policy summary response.",
  "properties": {
    "activated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Activated At"
    },
    "activated_by": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Activated By"
    },
    "activated_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Activated By Name"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "created_by": {
      "format": "uuid",
      "title": "Created By",
      "type": "string"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_active": {
      "title": "Is Active",
      "type": "boolean"
    },
    "is_draft": {
      "title": "Is Draft",
      "type": "boolean"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "rules": {
      "additionalProperties": true,
      "title": "Rules",
      "type": "object"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    },
    "version": {
      "title": "Version",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "version",
    "name",
    "rules",
    "is_active",
    "is_draft",
    "created_by",
    "created_at"
  ],
  "title": "ReleaseGatePolicyResponse",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/release-gate-policies — List Policies
• POST /api/v1/release-gate-policies — Create Policy
• GET /api/v1/release-gate-policies/{policy_id} — Get Policy
• PATCH /api/v1/release-gate-policies/{policy_id} — Update Policy
• POST /api/v1/release-gate-policies/{policy_id}/deactivate — Deactivate Policy
• POST /api/v1/release-gate-policies/{policy_id}/publish — Publish Policy
• GET /api/v1/release-gate-policies/effective/{project_id} — Get Effective Policy
• GET /api/v1/release-gate-policies/history/{project_id} — Get Policy History
• GET /api/v1/release-gate-policies/system-history — Get System Policy History

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON