RunCadencePatch

Fields

Every field optional; an empty PATCH changes nothing.

8 fields

clear_suite

boolean

cron

string or null

expected_by

string or null

grace_minutes

integer or null

mode

string or null

suite_name

string or null

timezone

string or null

weekdays

array of string or null

Raw schema (JSON)

{
  "additionalProperties": false,
  "description": "Every field optional; an empty PATCH changes nothing.",
  "properties": {
    "clear_suite": {
      "default": false,
      "title": "Clear Suite",
      "type": "boolean"
    },
    "cron": {
      "anyOf": [
        {
          "maxLength": 100,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cron"
    },
    "expected_by": {
      "anyOf": [
        {
          "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expected By"
    },
    "grace_minutes": {
      "anyOf": [
        {
          "maximum": 720,
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Grace Minutes"
    },
    "mode": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Mode"
    },
    "suite_name": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Name"
    },
    "timezone": {
      "anyOf": [
        {
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Timezone"
    },
    "weekdays": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "maxItems": 7,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Weekdays"
    }
  },
  "title": "RunCadencePatch",
  "type": "object"
}

Used by endpoints

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

• PATCH /api/v1/projects/{project_id}/run-cadences/{cadence_id} — Update Run Cadence

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON