Apache Airflow · JSON Structure

Airflow Hitl Detail History Structure

Schema for Human-in-the-loop detail history.

Type: object Properties: 14 Required: 4

Workflow OrchestrationData PipelineOpen SourceApacheDAGSchedulingETLData Engineering

HITLDetailHistory is a JSON Structure definition published by Apache Airflow, describing 14 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

options subject body defaults multiple params assigned_users created_at responded_by_user responded_at chosen_options params_input response_received task_instance

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airflow/refs/heads/main/json-structure/airflow-hitl-detail-history-structure.json",
  "name": "HITLDetailHistory",
  "description": "Schema for Human-in-the-loop detail history.",
  "type": "object",
  "properties": {
    "options": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "minItems": 1,
      "title": "Options"
    },
    "subject": {
      "type": "string",
      "title": "Subject"
    },
    "body": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Body"
    },
    "defaults": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Defaults"
    },
    "multiple": {
      "type": "boolean",
      "title": "Multiple",
      "default": false
    },
    "params": {
      "additionalProperties": true,
      "type": "object",
      "title": "Params"
    },
    "assigned_users": {
      "items": {
        "$ref": "#/components/schemas/HITLUser"
      },
      "type": "array",
      "title": "Assigned Users"
    },
    "created_at": {
      "type": "datetime",
      "title": "Created At"
    },
    "responded_by_user": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/HITLUser"
        },
        {
          "type": "null"
        }
      ]
    },
    "responded_at": {
      "anyOf": [
        {
          "type": "datetime"
        },
        {
          "type": "null"
        }
      ],
      "title": "Responded At"
    },
    "chosen_options": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Chosen Options"
    },
    "params_input": {
      "additionalProperties": true,
      "type": "object",
      "title": "Params Input"
    },
    "response_received": {
      "type": "boolean",
      "title": "Response Received",
      "default": false
    },
    "task_instance": {
      "$ref": "#/components/schemas/TaskInstanceHistoryResponse"
    }
  },
  "required": [
    "options",
    "subject",
    "created_at",
    "task_instance"
  ]
}