RetentionCriteria

Fields

What to delete. Every field is optional; at least one must be given.

9 fields

branches

array of string or null

date_from

string (date-time) or null

date_to

string (date-time) or null

environments

array of string or null

older_than_days

integer or null

run_ids

array of string (uuid) or null

statuses

array of string or null

suite_match

string

suite_names

array of string or null

Raw schema (JSON)

{
  "additionalProperties": false,
  "description": "What to delete. Every field is optional; at least one must be given.\n\n``suite_match`` decides what \"in this suite\" means for a run that contains\nseveral. ``only`` — the default — matches the run's own suite label and is\nthe conservative reading: it will not delete a multi-suite run because one\nof its suites was selected. ``any`` matches a run with any test case in the\nsuite, and is the destructive reading, so it is opt-in.",
  "properties": {
    "branches": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Branches"
    },
    "date_from": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Date From"
    },
    "date_to": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Date To"
    },
    "environments": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Environments"
    },
    "older_than_days": {
      "anyOf": [
        {
          "maximum": 3650,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Older Than Days"
    },
    "run_ids": {
      "anyOf": [
        {
          "items": {
            "format": "uuid",
            "type": "string"
          },
          "maxItems": 500,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Run Ids"
    },
    "statuses": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Statuses"
    },
    "suite_match": {
      "default": "only",
      "enum": [
        "only",
        "any"
      ],
      "title": "Suite Match",
      "type": "string"
    },
    "suite_names": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Names"
    }
  },
  "title": "RetentionCriteria",
  "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