RetentionPreviewResponse

Fields

POST .../retention-policy/preview — dry-run, writes nothing.

7 fields

candidates · required

RetentionPreviewCandidates

cutoffs · required

object

floor

RetentionPreviewFloor or null

holds

RetentionPreviewHolds

references_broken

array of ReferenceBrokenRead

references_measured

boolean

unmeasured

array of string

Raw schema (JSON)

{
  "description": "POST ``.../retention-policy/preview`` — dry-run, writes nothing.",
  "properties": {
    "candidates": {
      "$ref": "#/components/schemas/RetentionPreviewCandidates"
    },
    "cutoffs": {
      "additionalProperties": {
        "format": "date-time",
        "type": "string"
      },
      "title": "Cutoffs",
      "type": "object"
    },
    "floor": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RetentionPreviewFloor"
        },
        {
          "type": "null"
        }
      ]
    },
    "holds": {
      "$ref": "#/components/schemas/RetentionPreviewHolds"
    },
    "references_broken": {
      "items": {
        "$ref": "#/components/schemas/ReferenceBrokenRead"
      },
      "title": "References Broken",
      "type": "array"
    },
    "references_measured": {
      "default": true,
      "title": "References Measured",
      "type": "boolean"
    },
    "unmeasured": {
      "items": {
        "type": "string"
      },
      "title": "Unmeasured",
      "type": "array"
    }
  },
  "required": [
    "cutoffs",
    "candidates"
  ],
  "title": "RetentionPreviewResponse",
  "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}/retention-policy/preview — Preview Retention Purge

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON