Skip to content

HookResult ​

Type: object

FieldRequiredTypeDescription and constraints
idYesstringformat: "uuid"
nameYesstringenum: ["after_create","before_run","after_run","before_remove"]
statusYesstringenum: ["pending","running","completed","failed","cancelled","skipped"]
started_atYesstring / null
deadline_atYesstring / null
finished_atYesstring / null
exit_codeYesinteger / null
signalYesinteger / null
outputYesTextResult / TruncatedResult / null
output_completenessYesstringenum: ["complete","truncated","unavailable","unknown"]
truncation_reasonYesstring / null
errorYesError / null

JSON Schema ​

json
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "enum": [
        "after_create",
        "before_run",
        "after_run",
        "before_remove"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "running",
        "completed",
        "failed",
        "cancelled",
        "skipped"
      ]
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "deadline_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "finished_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "exit_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "signal": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "output": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/TextResult"
        },
        {
          "$ref": "#/components/schemas/TruncatedResult"
        },
        {
          "type": "null"
        }
      ]
    },
    "output_completeness": {
      "type": "string",
      "enum": [
        "complete",
        "truncated",
        "unavailable",
        "unknown"
      ]
    },
    "truncation_reason": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "orpheus_limit"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Error"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "started_at",
    "deadline_at",
    "finished_at",
    "exit_code",
    "signal",
    "output",
    "output_completeness",
    "truncation_reason",
    "error"
  ],
  "type": "object"
}

All schemas · HTTP API