DeletionPreviewResponse

Fields

A frozen candidate set an ADMIN authorises from.

13 fields

blocked

array of object

Runs that cannot be deleted and why — in flight, or cited by a compliance pack, release or decision report. Surfaced at preview so an ADMIN sees them before authorising, not after.

candidate_hash · required

string

export_estimate

ExportEstimate or null

floor_applies

boolean

floor_note

string

job_id · required

string (uuid)

project_id · required

string (uuid)

references_broken

array of ReferenceBrokenRead

references_measured

boolean

refused_prefixes

array of string

run_count · required

integer

run_ids · required

array of string (uuid)

truncated

boolean

The candidate set exceeded the reviewable bound and was cut. Reported rather than silently deleting the first N.

Raw schema (JSON)

{
  "description": "A frozen candidate set an ADMIN authorises from.\n\nThe ids are materialized and hashed here, and ``execute`` replays them.\nRe-resolving at execute time would delete a different set from the one\nthat was reviewed: criteria read columns other code rewrites while the job\nis queued (``TestRun.status`` by aggregate updates and live-session close,\n``primary_suite_name`` at session close).",
  "properties": {
    "blocked": {
      "description": "Runs that cannot be deleted and why — in flight, or cited by a compliance pack, release or decision report. Surfaced at preview so an ADMIN sees them before authorising, not after.",
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Blocked",
      "type": "array"
    },
    "candidate_hash": {
      "title": "Candidate Hash",
      "type": "string"
    },
    "export_estimate": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ExportEstimate"
        },
        {
          "type": "null"
        }
      ]
    },
    "floor_applies": {
      "default": false,
      "title": "Floor Applies",
      "type": "boolean"
    },
    "floor_note": {
      "default": "Explicit deletions are not limited by the keep-last floor; it applies to the scheduled purge only.",
      "title": "Floor Note",
      "type": "string"
    },
    "job_id": {
      "format": "uuid",
      "title": "Job Id",
      "type": "string"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "references_broken": {
      "items": {
        "$ref": "#/components/schemas/ReferenceBrokenRead"
      },
      "title": "References Broken",
      "type": "array"
    },
    "references_measured": {
      "default": true,
      "title": "References Measured",
      "type": "boolean"
    },
    "refused_prefixes": {
      "items": {
        "type": "string"
      },
      "title": "Refused Prefixes",
      "type": "array"
    },
    "run_count": {
      "title": "Run Count",
      "type": "integer"
    },
    "run_ids": {
      "items": {
        "format": "uuid",
        "type": "string"
      },
      "title": "Run Ids",
      "type": "array"
    },
    "truncated": {
      "default": false,
      "description": "The candidate set exceeded the reviewable bound and was cut. Reported rather than silently deleting the first N.",
      "title": "Truncated",
      "type": "boolean"
    }
  },
  "required": [
    "job_id",
    "project_id",
    "run_count",
    "run_ids",
    "candidate_hash"
  ],
  "title": "DeletionPreviewResponse",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/deletion/preview — Preview Criteria Deletion

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON