Unpublished SDK candidate: reviewed source snapshot of 13 September 2026; SDK modules, v2 writes and the external-worker dispatcher are unavailable in main. See availability and source.

SDK wire types

Generated by python3 scripts/sdk/reference.py. Do not edit generated tables.

These are the SDK candidate contracts. The current CPRa application serves v1 read-only endpoints; its v2 management and worker servers are not implemented. A listed SDK method is not evidence of a deployed server route. See the guide for runnable local examples.

Schema input SHA-256: 71723960b55145b57009faa9daa7fede20b08d85117171474b7c0631b4eb4977.

Optional fields use Go pointers where omission differs from an explicit zero or false. Merge patch uses JSON null to request deletion where permitted. Duration fields retain Go duration strings such as 60s. Resource ID, incarnation UID, resource version, control revision, incident ID, and execution ID have different meanings; never substitute one for another.

The descriptions below reproduce the schema contract. Inline nested shapes are included as JSON so no driver field is hidden by a summary table. externaljobs types are absent from default generated SDK packages.

Action

Field	Required	Type	Description
id	yes	string
monitorID	no	string
incarnationUID	no	string
incidentID	no	string
state	yes	string
kind	no	string
executionID	no	string
executionRevision	no	string
createdAt	no	string
updatedAt	no	string
reason	no	string
receiptID	no	string

{
  "additionalProperties": false,
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID",
      "x-go-type-skip-optional-pointer": true
    },
    "executionRevision": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "incarnationUID": {
      "type": "string",
      "x-go-name": "IncarnationUID",
      "x-go-type-skip-optional-pointer": true
    },
    "incidentID": {
      "type": "string",
      "x-go-name": "IncidentID",
      "x-go-type-skip-optional-pointer": true
    },
    "kind": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "monitorID": {
      "type": "string",
      "x-go-name": "MonitorID",
      "x-go-type-skip-optional-pointer": true
    },
    "reason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "receiptID": {
      "type": "string",
      "x-go-name": "ReceiptID",
      "x-go-type-skip-optional-pointer": true
    },
    "state": {
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "id",
    "state"
  ],
  "type": "object"
}

ActionList

Field	Required	Type	Description
items	yes	array of Action
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Action"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

AlertRule

Field	Required	Type	Description
dispatch	no	boolean
endpointRefs	no	array of string
groupRef	no	string
driver	no	DriverConfig

{
  "additionalProperties": false,
  "properties": {
    "dispatch": {
      "type": "boolean"
    },
    "driver": {
      "$ref": "#/components/schemas/DriverConfig"
    },
    "endpointRefs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "groupRef": {
      "type": "string"
    }
  },
  "type": "object"
}

ApplyItem

Field	Required	Type	Description
id	yes	string
contentDigest	yes	string
source	yes	string
resource	yes	Resource

{
  "additionalProperties": false,
  "properties": {
    "contentDigest": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "resource": {
      "$ref": "#/components/schemas/Resource"
    },
    "source": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "contentDigest",
    "source",
    "resource"
  ],
  "type": "object"
}

ApplyResult

Field	Required	Type	Description
id	yes	string
outcome	yes	string
oldVersion	no	string
newVersion	no	string
message	no	string
committed	no	boolean
applied	no	boolean

{
  "additionalProperties": false,
  "properties": {
    "applied": {
      "type": "boolean",
      "x-go-type-skip-optional-pointer": true
    },
    "committed": {
      "type": "boolean",
      "x-go-type-skip-optional-pointer": true
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "message": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "newVersion": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "oldVersion": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "outcome": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "outcome"
  ],
  "type": "object"
}

Assignment

Build requirement: externaljobs.

Field	Required	Type	Description
executionID	yes	string
executionRevision	yes	string
leaseID	yes	string
serverID	yes	string
monitorID	yes	string
incarnationUID	yes	string
jobTypeID	yes	string
jobTypeVersion	yes	string
kind	yes	string
parameters	yes	any JSON value
credentialProfile	yes	string
deadline	yes	string

{
  "additionalProperties": false,
  "properties": {
    "credentialProfile": {
      "type": "string"
    },
    "deadline": {
      "format": "date-time",
      "type": "string"
    },
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID"
    },
    "executionRevision": {
      "type": "string"
    },
    "incarnationUID": {
      "type": "string",
      "x-go-name": "IncarnationUID"
    },
    "jobTypeID": {
      "type": "string",
      "x-go-name": "JobTypeID"
    },
    "jobTypeVersion": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "leaseID": {
      "type": "string",
      "x-go-name": "LeaseID"
    },
    "monitorID": {
      "type": "string",
      "x-go-name": "MonitorID"
    },
    "parameters": {
      "x-go-type": "json.RawMessage"
    },
    "serverID": {
      "type": "string",
      "x-go-name": "ServerID"
    }
  },
  "required": [
    "executionID",
    "executionRevision",
    "leaseID",
    "serverID",
    "monitorID",
    "incarnationUID",
    "jobTypeID",
    "jobTypeVersion",
    "kind",
    "parameters",
    "credentialProfile",
    "deadline"
  ],
  "type": "object"
}

Assignments

Build requirement: externaljobs.

Field	Required	Type	Description
serverID	yes	string
items	yes	array of Assignment

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/Assignment"
      },
      "type": "array"
    },
    "serverID": {
      "type": "string",
      "x-go-name": "ServerID"
    }
  },
  "required": [
    "serverID",
    "items"
  ],
  "type": "object"
}

Capabilities

Field	Required	Type	Description
apiVersions	yes	array of string
drivers	yes	map of array of string
resources	yes	array of string
patchTypes	yes	array of string

{
  "additionalProperties": false,
  "properties": {
    "apiVersions": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "APIVersions"
    },
    "drivers": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "type": "object"
    },
    "patchTypes": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "resources": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "apiVersions",
    "drivers",
    "resources",
    "patchTypes"
  ],
  "type": "object"
}

CheckSpec

Field	Required	Type	Description
driver	yes	DriverConfig
interval	yes	Duration
timeout	yes	Duration
unhealthyThreshold	no	integer
healthyThreshold	no	integer
retries	no	integer
groups	no	array of string
maxFailures	no	integer

{
  "additionalProperties": false,
  "properties": {
    "driver": {
      "$ref": "#/components/schemas/DriverConfig"
    },
    "groups": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "healthyThreshold": {
      "format": "int64",
      "type": "integer"
    },
    "interval": {
      "$ref": "#/components/schemas/Duration"
    },
    "maxFailures": {
      "format": "int64",
      "type": "integer"
    },
    "retries": {
      "format": "int64",
      "type": "integer"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration"
    },
    "unhealthyThreshold": {
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "driver",
    "interval",
    "timeout"
  ],
  "type": "object"
}

CodeNotificationDatadog

Field	Required	Type	Description
url	no	string
apiKey	no	string
appKey	no	string
site	no	string
tags	no	array of string

{
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "type": "string",
      "x-go-name": "APIKey"
    },
    "appKey": {
      "type": "string",
      "x-go-name": "AppKey"
    },
    "site": {
      "type": "string",
      "x-go-name": "Site"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "Tags"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationDiscord

Field	Required	Type	Description
webhookUrl	no	string

{
  "additionalProperties": false,
  "properties": {
    "webhookUrl": {
      "type": "string",
      "x-go-name": "WebhookURL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationEmail

Field	Required	Type	Description
allowInsecure	no	boolean
to	no	string
from	no	string
server	no	string
subject	no	string

{
  "additionalProperties": false,
  "properties": {
    "allowInsecure": {
      "type": "boolean",
      "x-go-name": "AllowInsecure"
    },
    "from": {
      "type": "string",
      "x-go-name": "From"
    },
    "server": {
      "type": "string",
      "x-go-name": "Server"
    },
    "subject": {
      "type": "string",
      "x-go-name": "Subject"
    },
    "to": {
      "type": "string",
      "x-go-name": "To"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationLog

Field	Required	Type	Description
file	no	string

{
  "additionalProperties": false,
  "properties": {
    "file": {
      "type": "string",
      "x-go-name": "File"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationMattermost

Field	Required	Type	Description
webhookUrl	no	string
channel	no	string
username	no	string

{
  "additionalProperties": false,
  "properties": {
    "channel": {
      "type": "string",
      "x-go-name": "Channel"
    },
    "username": {
      "type": "string",
      "x-go-name": "Username"
    },
    "webhookUrl": {
      "type": "string",
      "x-go-name": "WebhookURL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationOpsgenie

Field	Required	Type	Description
apiKey	no	string
url	no	string

{
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "type": "string",
      "x-go-name": "APIKey"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationPagerDuty

Field	Required	Type	Description
routingKey	no	string
url	no	string

{
  "additionalProperties": false,
  "properties": {
    "routingKey": {
      "type": "string",
      "x-go-name": "RoutingKey"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationPushover

Field	Required	Type	Description
url	no	string
appToken	no	string
userKey	no	string
title	no	string
priority	no	integer
retry	no	integer
expire	no	integer
sound	no	string

{
  "additionalProperties": false,
  "properties": {
    "appToken": {
      "type": "string",
      "x-go-name": "AppToken"
    },
    "expire": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Expire"
    },
    "priority": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Priority"
    },
    "retry": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retry"
    },
    "sound": {
      "type": "string",
      "x-go-name": "Sound"
    },
    "title": {
      "type": "string",
      "x-go-name": "Title"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    },
    "userKey": {
      "type": "string",
      "x-go-name": "UserKey"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationSlack

Field	Required	Type	Description
hook	no	string

{
  "additionalProperties": false,
  "properties": {
    "hook": {
      "type": "string",
      "x-go-name": "WebHook"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationTeams

Field	Required	Type	Description
webhookUrl	no	string

{
  "additionalProperties": false,
  "properties": {
    "webhookUrl": {
      "type": "string",
      "x-go-name": "WebhookURL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationTelegram

Field	Required	Type	Description
url	no	string
testMode	no	boolean
botToken	no	string
chatId	no	string

{
  "additionalProperties": false,
  "properties": {
    "botToken": {
      "type": "string",
      "x-go-name": "BotToken"
    },
    "chatId": {
      "type": "string",
      "x-go-name": "ChatID"
    },
    "testMode": {
      "type": "boolean",
      "x-go-name": "TestMode"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationTwilio

Field	Required	Type	Description
url	no	string
accountSid	no	string
authToken	no	string
from	no	string
to	no	string

{
  "additionalProperties": false,
  "properties": {
    "accountSid": {
      "type": "string",
      "x-go-name": "AccountSID"
    },
    "authToken": {
      "type": "string",
      "x-go-name": "AuthToken"
    },
    "from": {
      "type": "string",
      "x-go-name": "From"
    },
    "to": {
      "type": "string",
      "x-go-name": "To"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationVictorOps

Field	Required	Type	Description
url	no	string
restEndpointKey	no	string
routingKey	no	string
messageType	no	string
entityId	no	string

{
  "additionalProperties": false,
  "properties": {
    "entityId": {
      "type": "string",
      "x-go-name": "EntityID"
    },
    "messageType": {
      "type": "string",
      "x-go-name": "MessageType"
    },
    "restEndpointKey": {
      "type": "string",
      "x-go-name": "RESTEndpointKey"
    },
    "routingKey": {
      "type": "string",
      "x-go-name": "RoutingKey"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

CodeNotificationWebhook

Field	Required	Type	Description
url	no	string
method	no	string
headers	no	map of string

{
  "additionalProperties": false,
  "properties": {
    "headers": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "x-go-name": "Headers"
    },
    "method": {
      "type": "string",
      "x-go-name": "Method"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

ControlRequest

Field	Required	Type	Description
revision	yes	string
reason	no	string
note	no	string
duration	no	Duration
incidentID	no	string
evidenceRefs	no	array of string
resolution	no	string

{
  "additionalProperties": false,
  "properties": {
    "duration": {
      "$ref": "#/components/schemas/Duration",
      "x-go-type-skip-optional-pointer": true
    },
    "evidenceRefs": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "incidentID": {
      "type": "string",
      "x-go-name": "IncidentID",
      "x-go-type-skip-optional-pointer": true
    },
    "note": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "reason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "resolution": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "revision": {
      "type": "string"
    }
  },
  "required": [
    "revision"
  ],
  "type": "object"
}

Credential

Field	Required	Type	Description
apiVersion	yes	string
kind	yes	string
metadata	yes	Metadata
spec	yes	CredentialSpec
status	no	any JSON value

{
  "additionalProperties": false,
  "properties": {
    "apiVersion": {
      "type": "string",
      "x-go-name": "APIVersion"
    },
    "kind": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/Metadata"
    },
    "spec": {
      "$ref": "#/components/schemas/CredentialSpec"
    },
    "status": {
      "x-go-type": "json.RawMessage",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata",
    "spec"
  ],
  "type": "object"
}

CredentialList

Field	Required	Type	Description
items	yes	array of Credential
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Credential"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

CredentialSpec

Field	Required	Type	Description
value	no	string
description	no	string

{
  "additionalProperties": false,
  "properties": {
    "description": {
      "type": "string"
    },
    "value": {
      "type": "string",
      "writeOnly": true
    }
  },
  "required": [],
  "type": "object"
}

DriverConfig

Field	Required	Type	Description
type	yes	string
config	yes	any JSON value
credentialRefs	no	map of string

{
  "additionalProperties": false,
  "properties": {
    "config": {
      "x-go-type": "json.RawMessage"
    },
    "credentialRefs": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "config"
  ],
  "type": "object"
}

Duration

Go duration string, e.g. 60s. Never numeric nanoseconds or ISO-8601.

{
  "description": "Go duration string, e.g. 60s. Never numeric nanoseconds or ISO-8601.",
  "type": "string",
  "x-go-type": "string"
}

Event

Field	Required	Type	Description
id	yes	string
monitorID	yes	string
kind	yes	string
time	yes	string
actor	no	string
reason	no	string
actionID	no	string
incidentID	no	string

{
  "additionalProperties": false,
  "properties": {
    "actionID": {
      "type": "string",
      "x-go-name": "ActionID",
      "x-go-type-skip-optional-pointer": true
    },
    "actor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "incidentID": {
      "type": "string",
      "x-go-name": "IncidentID",
      "x-go-type-skip-optional-pointer": true
    },
    "kind": {
      "type": "string"
    },
    "monitorID": {
      "type": "string",
      "x-go-name": "MonitorID"
    },
    "reason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "time": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "monitorID",
    "kind",
    "time"
  ],
  "type": "object"
}

EventList

Field	Required	Type	Description
items	yes	array of Event
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Event"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

Explanation

Field	Required	Type	Description
resource	yes	string
description	yes	string
schema	yes	any JSON value

{
  "additionalProperties": false,
  "properties": {
    "description": {
      "type": "string"
    },
    "resource": {
      "type": "string"
    },
    "schema": {
      "x-go-type": "json.RawMessage"
    }
  },
  "required": [
    "resource",
    "description",
    "schema"
  ],
  "type": "object"
}

ExternalConfig

Build requirement: externaljobs.

Field	Required	Type	Description
jobTypeID	yes	string
version	yes	string
parameters	yes	any JSON value
credentialProfile	no	string

{
  "additionalProperties": false,
  "properties": {
    "credentialProfile": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "jobTypeID": {
      "type": "string",
      "x-go-name": "JobTypeID"
    },
    "parameters": {
      "x-go-type": "json.RawMessage"
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "jobTypeID",
    "version",
    "parameters"
  ],
  "type": "object"
}

FieldError

Field	Required	Type	Description
field	yes	string
reason	no	string
message	yes	string

{
  "additionalProperties": false,
  "properties": {
    "field": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "field",
    "message"
  ],
  "type": "object"
}

Health

Field	Required	Type	Description
available	yes	boolean
reason	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "available": {
      "type": "boolean"
    },
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "reason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "available"
  ],
  "type": "object"
}

HeartbeatRequest

Build requirement: externaljobs.

Field	Required	Type	Description
workerID	yes	string
executionIDs	no	array of string
executionID	yes	string
grantID	yes	string

{
  "additionalProperties": false,
  "properties": {
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID"
    },
    "executionIDs": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "grantID": {
      "type": "string",
      "x-go-name": "GrantID"
    },
    "workerID": {
      "type": "string",
      "x-go-name": "WorkerID"
    }
  },
  "required": [
    "workerID",
    "executionID",
    "grantID"
  ],
  "type": "object"
}

HeartbeatResponse

Build requirement: externaljobs.

Field	Required	Type	Description
serverID	yes	string
accepted	yes	boolean

{
  "additionalProperties": false,
  "properties": {
    "accepted": {
      "type": "boolean"
    },
    "serverID": {
      "type": "string",
      "x-go-name": "ServerID"
    }
  },
  "required": [
    "serverID",
    "accepted"
  ],
  "type": "object"
}

Incident

Field	Required	Type	Description
id	yes	string
monitorID	yes	string
revision	yes	string
state	yes	string
openedAt	no	string
closedAt	no	string
acknowledgedBy	no	string
acknowledgedAt	no	string
dismissed	no	boolean

{
  "additionalProperties": false,
  "properties": {
    "acknowledgedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "acknowledgedBy": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "closedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "dismissed": {
      "type": "boolean",
      "x-go-type-skip-optional-pointer": true
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "monitorID": {
      "type": "string",
      "x-go-name": "MonitorID"
    },
    "openedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "revision": {
      "type": "string"
    },
    "state": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "monitorID",
    "revision",
    "state"
  ],
  "type": "object"
}

IncidentList

Field	Required	Type	Description
items	yes	array of Incident
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Incident"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

InterventionTargetAWS

Field	Required	Type	Description
type	no	string
region	no	string
operation	no	string
instanceId	no	string
timeout	no	Duration

{
  "additionalProperties": false,
  "properties": {
    "instanceId": {
      "type": "string",
      "x-go-name": "InstanceID"
    },
    "operation": {
      "type": "string",
      "x-go-name": "Operation"
    },
    "region": {
      "type": "string",
      "x-go-name": "Region"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "x-go-name": "Timeout"
    },
    "type": {
      "type": "string",
      "x-go-name": "Type"
    }
  },
  "required": [],
  "type": "object"
}

InterventionTargetDocker

Field	Required	Type	Description
type	no	string
container	no	string
timeout	no	Duration

{
  "additionalProperties": false,
  "properties": {
    "container": {
      "type": "string",
      "x-go-name": "Container"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "x-go-name": "Timeout"
    },
    "type": {
      "type": "string",
      "x-go-name": "Type"
    }
  },
  "required": [],
  "type": "object"
}

InterventionTargetKubernetes

Field	Required	Type	Description
type	no	string
kubeconfigPath	no	string
namespace	no	string
kind	no	string
name	no	string
replicas	no	integer
timeout	no	Duration

{
  "additionalProperties": false,
  "properties": {
    "kind": {
      "type": "string",
      "x-go-name": "Kind"
    },
    "kubeconfigPath": {
      "type": "string",
      "x-go-name": "KubeconfigPath"
    },
    "name": {
      "type": "string",
      "x-go-name": "Name"
    },
    "namespace": {
      "type": "string",
      "x-go-name": "Namespace"
    },
    "replicas": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Replicas"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "x-go-name": "Timeout"
    },
    "type": {
      "type": "string",
      "x-go-name": "Type"
    }
  },
  "required": [],
  "type": "object"
}

InterventionTargetSystemd

Field	Required	Type	Description
type	no	string
unit	no	string
mode	no	string
timeout	no	Duration

{
  "additionalProperties": false,
  "properties": {
    "mode": {
      "type": "string",
      "x-go-name": "Mode"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "x-go-name": "Timeout"
    },
    "type": {
      "type": "string",
      "x-go-name": "Type"
    },
    "unit": {
      "type": "string",
      "x-go-name": "Unit"
    }
  },
  "required": [],
  "type": "object"
}

InterventionTargetWebhook

Field	Required	Type	Description
type	no	string
url	no	string
method	no	string
headers	no	map of string
body	no	string
timeout	no	Duration

{
  "additionalProperties": false,
  "properties": {
    "body": {
      "type": "string",
      "x-go-name": "Body"
    },
    "headers": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "x-go-name": "Headers"
    },
    "method": {
      "type": "string",
      "x-go-name": "Method"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "x-go-name": "Timeout"
    },
    "type": {
      "type": "string",
      "x-go-name": "Type"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

JobType

Build requirement: externaljobs.

Field	Required	Type	Description
apiVersion	yes	string
kind	yes	string
metadata	yes	Metadata
spec	yes	JobTypeSpec

{
  "additionalProperties": false,
  "properties": {
    "apiVersion": {
      "type": "string",
      "x-go-name": "APIVersion"
    },
    "kind": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/Metadata"
    },
    "spec": {
      "$ref": "#/components/schemas/JobTypeSpec"
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata",
    "spec"
  ],
  "type": "object"
}

JobTypeList

Build requirement: externaljobs.

Field	Required	Type	Description
items	yes	array of JobType
nextCursor	no	string

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/JobType"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

JobTypeSpec

Build requirement: externaljobs.

Field	Required	Type	Description
version	yes	string
kind	yes	string
handler	yes	string
protocolVersion	yes	string
parameterSchema	yes	any JSON value
resultSchema	yes	any JSON value
timeout	no	Duration
rejectionCodes	no	array of string

{
  "additionalProperties": false,
  "properties": {
    "handler": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "parameterSchema": {
      "x-go-type": "json.RawMessage"
    },
    "protocolVersion": {
      "type": "string"
    },
    "rejectionCodes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "resultSchema": {
      "x-go-type": "json.RawMessage"
    },
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "x-go-type-skip-optional-pointer": true
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "version",
    "kind",
    "handler",
    "protocolVersion",
    "parameterSchema",
    "resultSchema"
  ],
  "type": "object"
}

LateEvidenceRequest

Build requirement: externaljobs.

Field	Required	Type	Description
executionID	yes	string
evidenceID	yes	string
evidence	yes	array of string
diagnostic	yes	string
originalReceiptID	yes	string
data	yes	any JSON value

{
  "additionalProperties": false,
  "properties": {
    "data": {
      "x-go-type": "json.RawMessage"
    },
    "diagnostic": {
      "type": "string"
    },
    "evidence": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "evidenceID": {
      "type": "string",
      "x-go-name": "EvidenceID"
    },
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID"
    },
    "originalReceiptID": {
      "type": "string",
      "x-go-name": "OriginalReceiptID"
    }
  },
  "required": [
    "executionID",
    "evidenceID",
    "evidence",
    "diagnostic",
    "originalReceiptID",
    "data"
  ],
  "type": "object"
}

MaintenanceWindow

Field	Required	Type	Description
start	no	string
end	no	string
cron	no	string
duration	no	Duration
timezone	no	string

{
  "additionalProperties": false,
  "properties": {
    "cron": {
      "type": "string"
    },
    "duration": {
      "$ref": "#/components/schemas/Duration"
    },
    "end": {
      "format": "date-time",
      "type": "string"
    },
    "start": {
      "format": "date-time",
      "type": "string"
    },
    "timezone": {
      "type": "string"
    }
  },
  "required": [],
  "type": "object"
}

Measurement

Field	Required	Type	Description
available	yes	boolean
value	no	number
reason	no	string

{
  "additionalProperties": false,
  "properties": {
    "available": {
      "type": "boolean"
    },
    "reason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "value": {
      "format": "double",
      "type": "number",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "available"
  ],
  "type": "object"
}

MergePatch

{
  "x-go-type": "json.RawMessage"
}

Metadata

Field	Required	Type	Description
id	yes	string
uid	no	string
name	no	string
resourceVersion	no	string
generation	no	integer
labels	no	map of string

{
  "additionalProperties": false,
  "properties": {
    "generation": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "resourceVersion": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "uid": {
      "type": "string",
      "x-go-name": "UID",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Metrics

Field	Required	Type	Description
generatedAt	yes	string
queues	no	array of Queue
pools	no	array of Pool
systems	no	array of System
slo	no	SLOView

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "pools": {
      "items": {
        "$ref": "#/components/schemas/Pool"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "queues": {
      "items": {
        "$ref": "#/components/schemas/Queue"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "slo": {
      "$ref": "#/components/schemas/SLOView",
      "x-go-name": "SLO",
      "x-go-type-skip-optional-pointer": true
    },
    "systems": {
      "items": {
        "$ref": "#/components/schemas/System"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "generatedAt"
  ],
  "type": "object"
}

Monitor

Field	Required	Type	Description
apiVersion	yes	string
kind	yes	string
metadata	yes	Metadata
spec	yes	MonitorSpec
status	no	MonitorStatus

{
  "additionalProperties": false,
  "properties": {
    "apiVersion": {
      "type": "string",
      "x-go-name": "APIVersion"
    },
    "kind": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/Metadata"
    },
    "spec": {
      "$ref": "#/components/schemas/MonitorSpec"
    },
    "status": {
      "$ref": "#/components/schemas/MonitorStatus",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata",
    "spec"
  ],
  "type": "object"
}

MonitorList

Field	Required	Type	Description
items	yes	array of Monitor
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Monitor"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

MonitorSpec

Field	Required	Type	Description
enabled	no	boolean
check	yes	CheckSpec
recovery	no	RecoverySpec
notificationGroupRefs	no	array of string
notifications	no	map of AlertRule
maintenance	no	array of MaintenanceWindow
tags	no	array of string

{
  "additionalProperties": false,
  "properties": {
    "check": {
      "$ref": "#/components/schemas/CheckSpec"
    },
    "enabled": {
      "type": "boolean"
    },
    "maintenance": {
      "items": {
        "$ref": "#/components/schemas/MaintenanceWindow"
      },
      "type": "array"
    },
    "notificationGroupRefs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "notifications": {
      "additionalProperties": {
        "$ref": "#/components/schemas/AlertRule"
      },
      "type": "object"
    },
    "recovery": {
      "$ref": "#/components/schemas/RecoverySpec"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "check"
  ],
  "type": "object"
}

MonitorStatus

Field	Required	Type	Description
observedGeneration	no	integer
controlRevision	no	string
statusRevision	no	string
executionRevision	no	string
health	no	string
lastCheckedAt	no	string
lastCheckLatencyMs	no	Measurement
snoozedUntil	no	string
incidentID	no	string
unknownActions	no	integer

{
  "additionalProperties": false,
  "properties": {
    "controlRevision": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "executionRevision": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "health": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "incidentID": {
      "type": "string",
      "x-go-name": "IncidentID",
      "x-go-type-skip-optional-pointer": true
    },
    "lastCheckLatencyMs": {
      "$ref": "#/components/schemas/Measurement",
      "x-go-name": "LastCheckLatencyMS",
      "x-go-type-skip-optional-pointer": true
    },
    "lastCheckedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "observedGeneration": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "snoozedUntil": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "statusRevision": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "unknownActions": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [],
  "type": "object"
}

NotificationEndpoint

Field	Required	Type	Description
apiVersion	yes	string
kind	yes	string
metadata	yes	Metadata
spec	yes	DriverConfig
status	no	any JSON value

{
  "additionalProperties": false,
  "properties": {
    "apiVersion": {
      "type": "string",
      "x-go-name": "APIVersion"
    },
    "kind": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/Metadata"
    },
    "spec": {
      "$ref": "#/components/schemas/DriverConfig"
    },
    "status": {
      "x-go-type": "json.RawMessage",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata",
    "spec"
  ],
  "type": "object"
}

NotificationEndpointList

Field	Required	Type	Description
items	yes	array of NotificationEndpoint
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/NotificationEndpoint"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

NotificationGroup

Field	Required	Type	Description
apiVersion	yes	string
kind	yes	string
metadata	yes	Metadata
spec	yes	NotificationGroupSpec
status	no	any JSON value

{
  "additionalProperties": false,
  "properties": {
    "apiVersion": {
      "type": "string",
      "x-go-name": "APIVersion"
    },
    "kind": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/Metadata"
    },
    "spec": {
      "$ref": "#/components/schemas/NotificationGroupSpec"
    },
    "status": {
      "x-go-type": "json.RawMessage",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata",
    "spec"
  ],
  "type": "object"
}

NotificationGroupList

Field	Required	Type	Description
items	yes	array of NotificationGroup
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/NotificationGroup"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

NotificationGroupSpec

Field	Required	Type	Description
endpointRefs	yes	array of string

{
  "additionalProperties": false,
  "properties": {
    "endpointRefs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "endpointRefs"
  ],
  "type": "object"
}

Operation

Field	Required	Type	Description
id	yes	string
state	yes	string
contentDigest	yes	string
items	no	array of ApplyResult
nextCursor	no	string
retryAfterSeconds	no	integer
committed	no	integer
applied	no	integer
uploaded	no	integer
validated	no	boolean

{
  "additionalProperties": false,
  "properties": {
    "applied": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "committed": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "contentDigest": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "x-go-name": "ID"
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/ApplyResult"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "retryAfterSeconds": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "state": {
      "type": "string"
    },
    "uploaded": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "validated": {
      "type": "boolean",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "id",
    "state",
    "contentDigest"
  ],
  "type": "object"
}

OperationCreateRequest

Field	Required	Type	Description
contentDigest	yes	string
itemCount	yes	integer

{
  "additionalProperties": false,
  "properties": {
    "contentDigest": {
      "type": "string"
    },
    "itemCount": {
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "contentDigest",
    "itemCount"
  ],
  "type": "object"
}

Outcome

Build requirement: externaljobs.

Field	Required	Type	Description
executionID	yes	string
grantID	yes	string
kind	yes	string
status	yes	string
diagnostic	yes	string
rejectionCode	yes	string
evidence	yes	array of string
data	yes	any JSON value
diagnosticTruncated	yes	boolean

{
  "additionalProperties": false,
  "properties": {
    "data": {
      "x-go-type": "json.RawMessage"
    },
    "diagnostic": {
      "type": "string"
    },
    "diagnosticTruncated": {
      "type": "boolean"
    },
    "evidence": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID"
    },
    "grantID": {
      "type": "string",
      "x-go-name": "GrantID"
    },
    "kind": {
      "type": "string"
    },
    "rejectionCode": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  },
  "required": [
    "executionID",
    "grantID",
    "kind",
    "status",
    "diagnostic",
    "rejectionCode",
    "evidence",
    "data",
    "diagnosticTruncated"
  ],
  "type": "object"
}

Percentiles

Field	Required	Type	Description
available	yes	boolean
p50Ms	no	number
p95Ms	no	number
p99Ms	no	number

{
  "additionalProperties": false,
  "properties": {
    "available": {
      "type": "boolean"
    },
    "p50Ms": {
      "format": "double",
      "type": "number",
      "x-go-name": "P50MS",
      "x-go-type-skip-optional-pointer": true
    },
    "p95Ms": {
      "format": "double",
      "type": "number",
      "x-go-name": "P95MS",
      "x-go-type-skip-optional-pointer": true
    },
    "p99Ms": {
      "format": "double",
      "type": "number",
      "x-go-name": "P99MS",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "available"
  ],
  "type": "object"
}

PollRequest

Build requirement: externaljobs.

Field	Required	Type	Description
workerID	yes	string
capabilities	yes	array of WorkerCapability
capacity	yes	integer
limit	yes	integer
waitSeconds	yes	integer

{
  "additionalProperties": false,
  "properties": {
    "capabilities": {
      "items": {
        "$ref": "#/components/schemas/WorkerCapability"
      },
      "type": "array"
    },
    "capacity": {
      "format": "int64",
      "type": "integer"
    },
    "limit": {
      "format": "int64",
      "type": "integer"
    },
    "waitSeconds": {
      "format": "int64",
      "type": "integer"
    },
    "workerID": {
      "type": "string",
      "x-go-name": "WorkerID"
    }
  },
  "required": [
    "workerID",
    "capabilities",
    "capacity",
    "limit",
    "waitSeconds"
  ],
  "type": "object"
}

Pool

Field	Required	Type	Description
name	yes	string
workers	yes	integer
minimum	no	integer
maximum	no	integer
busy	no	integer
modelRecommendation	no	integer
adjustmentReason	no	string

{
  "additionalProperties": false,
  "properties": {
    "adjustmentReason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "busy": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "maximum": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "minimum": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "modelRecommendation": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "name": {
      "type": "string"
    },
    "workers": {
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "name",
    "workers"
  ],
  "type": "object"
}

PoolList

Field	Required	Type	Description
items	yes	array of Pool
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Pool"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

Preflight

Field	Required	Type	Description
valid	yes	boolean
contentDigest	no	string
items	no	array of ApplyResult
errors	no	array of FieldError

{
  "additionalProperties": false,
  "properties": {
    "contentDigest": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "errors": {
      "items": {
        "$ref": "#/components/schemas/FieldError"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/ApplyResult"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "valid": {
      "type": "boolean"
    }
  },
  "required": [
    "valid"
  ],
  "type": "object"
}

PreflightRequest

Field	Required	Type	Description
items	yes	array of ApplyItem

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/ApplyItem"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

Problem

Field	Required	Type	Description
type	no	string
title	no	string
status	no	integer
detail	no	string
instance	no	string
requestID	no	string
operationID	no	string
code	no	string
errors	no	array of FieldError

{
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "detail": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "errors": {
      "items": {
        "$ref": "#/components/schemas/FieldError"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "instance": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "operationID": {
      "type": "string",
      "x-go-name": "OperationID",
      "x-go-type-skip-optional-pointer": true
    },
    "requestID": {
      "type": "string",
      "x-go-name": "RequestID",
      "x-go-type-skip-optional-pointer": true
    },
    "status": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "title": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "type": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [],
  "type": "object"
}

PulseDNSConfig

Field	Required	Type	Description
host	no	string
server	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "server": {
      "type": "string",
      "x-go-name": "Server"
    }
  },
  "required": [],
  "type": "object"
}

PulseDockerConfig

Field	Required	Type	Description
container	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "container": {
      "type": "string",
      "x-go-name": "Container"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    }
  },
  "required": [],
  "type": "object"
}

PulseGRPCConfig

Field	Required	Type	Description
host	no	string
port	no	integer
service	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "port": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Port"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "service": {
      "type": "string",
      "x-go-name": "Service"
    }
  },
  "required": [],
  "type": "object"
}

PulseHTTPConfig

Field	Required	Type	Description
url	no	string
method	no	string
headers	no	map of string
body	no	string
expectedStatus	no	array of integer
insecureSkipVerify	no	boolean
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "body": {
      "type": "string",
      "x-go-name": "Body"
    },
    "expectedStatus": {
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "type": "array",
      "x-go-name": "ExpectedStatus"
    },
    "headers": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "x-go-name": "Headers"
    },
    "insecureSkipVerify": {
      "type": "boolean",
      "x-go-name": "InsecureSkipVerify"
    },
    "method": {
      "type": "string",
      "x-go-name": "Method"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

PulseICMPConfig

Field	Required	Type	Description
host	no	string
ignorePrivilege	no	boolean
count	no	integer
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "count": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Count"
    },
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "ignorePrivilege": {
      "type": "boolean",
      "x-go-name": "Privilege"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    }
  },
  "required": [],
  "type": "object"
}

PulseKafkaConfig

Field	Required	Type	Description
brokers	no	array of string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "brokers": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "Brokers"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    }
  },
  "required": [],
  "type": "object"
}

PulseMongoConfig

Field	Required	Type	Description
uri	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "uri": {
      "type": "string",
      "x-go-name": "URI"
    }
  },
  "required": [],
  "type": "object"
}

PulseMySQLConfig

Field	Required	Type	Description
dsn	no	string
host	no	string
port	no	integer
user	no	string
password	no	string
database	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "database": {
      "type": "string",
      "x-go-name": "Database"
    },
    "dsn": {
      "type": "string",
      "x-go-name": "DSN"
    },
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "password": {
      "type": "string",
      "x-go-name": "Password"
    },
    "port": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Port"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "user": {
      "type": "string",
      "x-go-name": "User"
    }
  },
  "required": [],
  "type": "object"
}

PulsePostgresConfig

Field	Required	Type	Description
dsn	no	string
host	no	string
port	no	integer
user	no	string
password	no	string
database	no	string
sslmode	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "database": {
      "type": "string",
      "x-go-name": "Database"
    },
    "dsn": {
      "type": "string",
      "x-go-name": "DSN"
    },
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "password": {
      "type": "string",
      "x-go-name": "Password"
    },
    "port": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Port"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "sslmode": {
      "type": "string",
      "x-go-name": "SSLMode"
    },
    "user": {
      "type": "string",
      "x-go-name": "User"
    }
  },
  "required": [],
  "type": "object"
}

PulseRabbitMQConfig

Field	Required	Type	Description
url	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "required": [],
  "type": "object"
}

PulseRedisConfig

Field	Required	Type	Description
addr	no	string
password	no	string
username	no	string
db	no	integer
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "addr": {
      "type": "string",
      "x-go-name": "Addr"
    },
    "db": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "DB"
    },
    "password": {
      "type": "string",
      "x-go-name": "Password"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "username": {
      "type": "string",
      "x-go-name": "Username"
    }
  },
  "required": [],
  "type": "object"
}

PulseTCPConfig

Field	Required	Type	Description
host	no	string
port	no	integer
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "port": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Port"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    }
  },
  "required": [],
  "type": "object"
}

PulseTLSConfig

Field	Required	Type	Description
host	no	string
port	no	integer
serverName	no	string
warnDays	no	integer
criticalDays	no	integer
insecureSkipVerify	no	boolean
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "criticalDays": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "CriticalDays"
    },
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "insecureSkipVerify": {
      "type": "boolean",
      "x-go-name": "InsecureSkipVerify"
    },
    "port": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Port"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    },
    "serverName": {
      "type": "string",
      "x-go-name": "ServerName"
    },
    "warnDays": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "WarnDays"
    }
  },
  "required": [],
  "type": "object"
}

PulseUDPConfig

Field	Required	Type	Description
host	no	string
port	no	integer
payload	no	string
retries	no	integer

{
  "additionalProperties": false,
  "properties": {
    "host": {
      "type": "string",
      "x-go-name": "Host"
    },
    "payload": {
      "type": "string",
      "x-go-name": "Payload"
    },
    "port": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Port"
    },
    "retries": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Retries"
    }
  },
  "required": [],
  "type": "object"
}

Queue

Field	Required	Type	Description
name	yes	string
depth	yes	integer
capacity	yes	integer
oldestPendingMs	no	Measurement
enqueuedPerSecond	no	number
completedPerSecond	no	number
drops	no	integer
saturated	yes	boolean
limitReason	no	string

{
  "additionalProperties": false,
  "properties": {
    "capacity": {
      "format": "int64",
      "type": "integer"
    },
    "completedPerSecond": {
      "format": "double",
      "type": "number",
      "x-go-type-skip-optional-pointer": true
    },
    "depth": {
      "format": "int64",
      "type": "integer"
    },
    "drops": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "enqueuedPerSecond": {
      "format": "double",
      "type": "number",
      "x-go-type-skip-optional-pointer": true
    },
    "limitReason": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "name": {
      "type": "string"
    },
    "oldestPendingMs": {
      "$ref": "#/components/schemas/Measurement",
      "x-go-name": "OldestPendingMS",
      "x-go-type-skip-optional-pointer": true
    },
    "saturated": {
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "depth",
    "capacity",
    "saturated"
  ],
  "type": "object"
}

QueueList

Field	Required	Type	Description
items	yes	array of Queue
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/Queue"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

Receipt

Build requirement: externaljobs.

Field	Required	Type	Description
executionID	yes	string
receiptID	yes	string
disposition	yes	string
serverID	yes	string

{
  "additionalProperties": false,
  "properties": {
    "disposition": {
      "type": "string"
    },
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID"
    },
    "receiptID": {
      "type": "string",
      "x-go-name": "ReceiptID"
    },
    "serverID": {
      "type": "string",
      "x-go-name": "ServerID"
    }
  },
  "required": [
    "executionID",
    "receiptID",
    "disposition",
    "serverID"
  ],
  "type": "object"
}

RecoverySpec

Field	Required	Type	Description
driver	yes	DriverConfig
maxAttempts	no	integer
cooldown	no	Duration
retries	no	integer
maxFailures	no	integer

{
  "additionalProperties": false,
  "properties": {
    "cooldown": {
      "$ref": "#/components/schemas/Duration"
    },
    "driver": {
      "$ref": "#/components/schemas/DriverConfig"
    },
    "maxAttempts": {
      "format": "int64",
      "type": "integer"
    },
    "maxFailures": {
      "format": "int64",
      "type": "integer"
    },
    "retries": {
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "driver"
  ],
  "type": "object"
}

Resource

Field	Required	Type	Description
apiVersion	yes	string
kind	yes	string
metadata	yes	Metadata
spec	yes	any JSON value
status	no	any JSON value

{
  "additionalProperties": false,
  "properties": {
    "apiVersion": {
      "type": "string",
      "x-go-name": "APIVersion"
    },
    "kind": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/Metadata"
    },
    "spec": {
      "x-go-type": "json.RawMessage"
    },
    "status": {
      "x-go-type": "json.RawMessage",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "apiVersion",
    "kind",
    "metadata",
    "spec"
  ],
  "type": "object"
}

RuntimeConfig

Field	Required	Type	Description
storageMode	no	string
historyRetention	no	Duration
queueCapacity	no	integer
readOnly	no	boolean
sloWindow	no	Duration

{
  "additionalProperties": false,
  "properties": {
    "historyRetention": {
      "$ref": "#/components/schemas/Duration",
      "x-go-type-skip-optional-pointer": true
    },
    "queueCapacity": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "readOnly": {
      "type": "boolean",
      "x-go-type-skip-optional-pointer": true
    },
    "sloWindow": {
      "$ref": "#/components/schemas/Duration",
      "x-go-type-skip-optional-pointer": true
    },
    "storageMode": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [],
  "type": "object"
}

SLOReport

Field	Required	Type	Description
pipeline	yes	string
driver	yes	string
samples	yes	integer
missed	no	integer
timeouts	no	integer
queueDelay	no	Percentiles
execution	no	Percentiles
totalLatency	no	Percentiles
queueThresholdPassed	no	integer
totalThresholdPassed	no	integer
attainment	no	Measurement
condition	no	string

{
  "additionalProperties": false,
  "properties": {
    "attainment": {
      "$ref": "#/components/schemas/Measurement",
      "x-go-type-skip-optional-pointer": true
    },
    "condition": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "driver": {
      "type": "string"
    },
    "execution": {
      "$ref": "#/components/schemas/Percentiles",
      "x-go-type-skip-optional-pointer": true
    },
    "missed": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "pipeline": {
      "type": "string"
    },
    "queueDelay": {
      "$ref": "#/components/schemas/Percentiles",
      "x-go-type-skip-optional-pointer": true
    },
    "queueThresholdPassed": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "samples": {
      "format": "int64",
      "type": "integer"
    },
    "timeouts": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "totalLatency": {
      "$ref": "#/components/schemas/Percentiles",
      "x-go-type-skip-optional-pointer": true
    },
    "totalThresholdPassed": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "pipeline",
    "driver",
    "samples"
  ],
  "type": "object"
}

SLOView

Field	Required	Type	Description
generatedAt	yes	string
window	yes	Duration
coverageGap	yes	boolean
reports	yes	array of SLOReport

{
  "additionalProperties": false,
  "properties": {
    "coverageGap": {
      "type": "boolean"
    },
    "generatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "reports": {
      "items": {
        "$ref": "#/components/schemas/SLOReport"
      },
      "type": "array"
    },
    "window": {
      "$ref": "#/components/schemas/Duration"
    }
  },
  "required": [
    "generatedAt",
    "window",
    "coverageGap",
    "reports"
  ],
  "type": "object"
}

StartRequest

Build requirement: externaljobs.

Field	Required	Type	Description
executionID	yes	string
leaseID	yes	string
executionRevision	yes	string

{
  "additionalProperties": false,
  "properties": {
    "executionID": {
      "type": "string",
      "x-go-name": "ExecutionID"
    },
    "executionRevision": {
      "type": "string"
    },
    "leaseID": {
      "type": "string",
      "x-go-name": "LeaseID"
    }
  },
  "required": [
    "executionID",
    "leaseID",
    "executionRevision"
  ],
  "type": "object"
}

StartResponse

Build requirement: externaljobs.

Field	Required	Type	Description
disposition	yes	string
grantID	yes	string
serverID	yes	string
deadline	yes	string
receiptID	yes	string

{
  "additionalProperties": false,
  "properties": {
    "deadline": {
      "format": "date-time",
      "type": "string"
    },
    "disposition": {
      "type": "string"
    },
    "grantID": {
      "type": "string",
      "x-go-name": "GrantID"
    },
    "receiptID": {
      "type": "string",
      "x-go-name": "ReceiptID"
    },
    "serverID": {
      "type": "string",
      "x-go-name": "ServerID"
    }
  },
  "required": [
    "disposition",
    "grantID",
    "serverID",
    "deadline",
    "receiptID"
  ],
  "type": "object"
}

State

Field	Required	Type	Description
generatedAt	yes	string
ready	yes	boolean
live	yes	boolean
storage	yes	StorageState
projectionAgeMs	no	number
unknownActions	no	integer
actions	no	array of Action

{
  "additionalProperties": false,
  "properties": {
    "actions": {
      "items": {
        "$ref": "#/components/schemas/Action"
      },
      "type": "array",
      "x-go-type-skip-optional-pointer": true
    },
    "generatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "live": {
      "type": "boolean"
    },
    "projectionAgeMs": {
      "format": "double",
      "type": "number",
      "x-go-name": "ProjectionAgeMS",
      "x-go-type-skip-optional-pointer": true
    },
    "ready": {
      "type": "boolean"
    },
    "storage": {
      "$ref": "#/components/schemas/StorageState"
    },
    "unknownActions": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "generatedAt",
    "ready",
    "live",
    "storage"
  ],
  "type": "object"
}

StorageState

Field	Required	Type	Description
available	yes	boolean
mode	yes	string
formatVersion	no	integer
commitIndex	no	integer
appliedIndex	no	integer
bytes	no	integer
error	no	string

{
  "additionalProperties": false,
  "properties": {
    "appliedIndex": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "available": {
      "type": "boolean"
    },
    "bytes": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "commitIndex": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "error": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "formatVersion": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "mode": {
      "type": "string"
    }
  },
  "required": [
    "available",
    "mode"
  ],
  "type": "object"
}

System

Field	Required	Type	Description
name	yes	string
updates	no	integer
entitiesProcessed	no	integer
lastUpdateDurationMs	no	Measurement
progressAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "entitiesProcessed": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "lastUpdateDurationMs": {
      "$ref": "#/components/schemas/Measurement",
      "x-go-name": "LastUpdateDurationMS",
      "x-go-type-skip-optional-pointer": true
    },
    "name": {
      "type": "string"
    },
    "progressAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "updates": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

SystemList

Field	Required	Type	Description
items	yes	array of System
nextCursor	no	string
snapshot	no	string
generatedAt	no	string

{
  "additionalProperties": false,
  "properties": {
    "generatedAt": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "items": {
      "items": {
        "$ref": "#/components/schemas/System"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "snapshot": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

UploadRequest

Field	Required	Type	Description
items	yes	array of ApplyItem

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/ApplyItem"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}

Version

Field	Required	Type	Description
version	yes	string
commit	no	string
sourceTime	no	string
goVersion	no	string
storageFormat	no	integer

{
  "additionalProperties": false,
  "properties": {
    "commit": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "goVersion": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "sourceTime": {
      "format": "date-time",
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    },
    "storageFormat": {
      "format": "int64",
      "type": "integer",
      "x-go-type-skip-optional-pointer": true
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "version"
  ],
  "type": "object"
}

WorkerCapability

Build requirement: externaljobs.

Field	Required	Type	Description
jobTypeID	yes	string
version	yes	string
kind	yes	string

{
  "additionalProperties": false,
  "properties": {
    "jobTypeID": {
      "type": "string",
      "x-go-name": "JobTypeID"
    },
    "kind": {
      "type": "string"
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "jobTypeID",
    "version",
    "kind"
  ],
  "type": "object"
}

WorkerObservation

Build requirement: externaljobs.

Field	Required	Type	Description
workerID	yes	string
capacity	yes	integer
active	yes	integer
lastSeenAt	yes	string

{
  "additionalProperties": false,
  "properties": {
    "active": {
      "format": "int64",
      "type": "integer"
    },
    "capacity": {
      "format": "int64",
      "type": "integer"
    },
    "lastSeenAt": {
      "format": "date-time",
      "type": "string"
    },
    "workerID": {
      "type": "string",
      "x-go-name": "WorkerID"
    }
  },
  "required": [
    "workerID",
    "capacity",
    "active",
    "lastSeenAt"
  ],
  "type": "object"
}

WorkerObservationList

Build requirement: externaljobs.

Field	Required	Type	Description
items	yes	array of WorkerObservation
nextCursor	no	string

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/WorkerObservation"
      },
      "type": "array"
    },
    "nextCursor": {
      "type": "string",
      "x-go-type-skip-optional-pointer": true
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}