HarnessApprovalActivityRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/harness/main/json-schema/harness-harness-approval-activity-request-schema.json",
  "title": "HarnessApprovalActivityRequest",
  "description": "Details of approval activity requested",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/harness-approvals-api-openapi.yml#/components/schemas/HarnessApprovalActivityRequest",
  "required": [
    "action"
  ],
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Approval activity action",
      "enum": [
        "APPROVE",
        "REJECT"
      ]
    },
    "approverInputs": {
      "type": "array",
      "description": "Custom data to capture at the time of approval",
      "items": {
        "$ref": "#/$defs/ApproverInput"
      }
    },
    "comments": {
      "type": "string",
      "description": "Approval activity with the comment"
    },
    "autoApprove": {
      "type": "boolean"
    }
  },
  "$defs": {
    "ApproverInput": {
      "required": [
        "name",
        "value"
      ],
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "description": "Custom data to capture at the time of approval"
    }
  }
}