PhaseUpdate

Fields

13 fields

actual_end

string (date-time) or null

actual_start

string (date-time) or null

description

string or null

exit_criteria

object or null

gate_override_reason

string or null

name

string or null

notes

string or null

order_index

integer or null

phase_type

string or null

planned_end

string (date-time) or null

planned_start

string (date-time) or null

skip_reason

string or null

status

string or null

Raw schema (JSON)

{
  "properties": {
    "actual_end": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Actual End"
    },
    "actual_start": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Actual Start"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "exit_criteria": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Exit Criteria"
    },
    "gate_override_reason": {
      "anyOf": [
        {
          "maxLength": 1000,
          "minLength": 3,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Gate Override Reason"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "order_index": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Order Index"
    },
    "phase_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Phase Type"
    },
    "planned_end": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Planned End"
    },
    "planned_start": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Planned Start"
    },
    "skip_reason": {
      "anyOf": [
        {
          "maxLength": 1000,
          "minLength": 3,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skip Reason"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Status"
    }
  },
  "title": "PhaseUpdate",
  "type": "object"
}

Used by endpoints

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

• PUT /api/v1/releases/{release_id}/phases/{phase_id} — Update Phase

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON