Skip to main content

Variable: BRIDGE_V2_SCHEMA

const BRIDGE_V2_SCHEMA: object

Type Declaration​

$defs​

readonly $defs: object

$defs.activityTaskRef​

readonly activityTaskRef: object

$defs.activityTaskRef.additionalProperties​

readonly additionalProperties: false

$defs.activityTaskRef.properties​

readonly properties: object

$defs.activityTaskRef.properties.activityId​

readonly activityId: object

$defs.activityTaskRef.properties.activityId.maxLength​

readonly maxLength: 256

$defs.activityTaskRef.properties.activityId.minLength​

readonly minLength: 1

$defs.activityTaskRef.properties.activityId.type​

readonly type: "string"

$defs.activityTaskRef.properties.attempt​

readonly attempt: object

$defs.activityTaskRef.properties.attempt.minimum​

readonly minimum: 1

$defs.activityTaskRef.properties.attempt.type​

readonly type: "integer"

$defs.activityTaskRef.properties.kind​

readonly kind: object

$defs.activityTaskRef.properties.kind.const​

readonly const: "activity"

$defs.activityTaskRef.properties.runId​

readonly runId: object

$defs.activityTaskRef.properties.runId.maxLength​

readonly maxLength: 256

$defs.activityTaskRef.properties.runId.minLength​

readonly minLength: 1

$defs.activityTaskRef.properties.runId.type​

readonly type: "string"

$defs.activityTaskRef.required​

readonly required: readonly ["kind", "runId", "activityId", "attempt"]

$defs.activityTaskRef.type​

readonly type: "object"

$defs.bye​

readonly bye: Record<string, unknown>

$defs.cancel​

readonly cancel: Record<string, unknown>

$defs.heartbeat​

readonly heartbeat: Record<string, unknown>

$defs.heartbeatAck​

readonly heartbeatAck: Record<string, unknown>

$defs.hello​

readonly hello: Record<string, unknown>

$defs.historyPage​

readonly historyPage: object

$defs.historyPage.additionalProperties​

readonly additionalProperties: false

$defs.historyPage.properties​

readonly properties: object

$defs.historyPage.properties.events​

readonly events: object

$defs.historyPage.properties.events.items​

readonly items: object

$defs.historyPage.properties.events.items.type​

readonly type: "object"

$defs.historyPage.properties.events.type​

readonly type: "array"

$defs.historyPage.properties.from​

readonly from: object

$defs.historyPage.properties.from.minimum​

readonly minimum: 1

$defs.historyPage.properties.from.type​

readonly type: "integer"

$defs.historyPage.properties.hasMore​

readonly hasMore: object

$defs.historyPage.properties.hasMore.type​

readonly type: "boolean"

$defs.historyPage.properties.nextAfter​

readonly nextAfter: object

$defs.historyPage.properties.nextAfter.oneOf​

readonly oneOf: readonly [{ type: "null"; }, { minimum: 1; type: "integer"; }]

$defs.historyPage.required​

readonly required: readonly ["events", "from", "nextAfter", "hasMore"]

$defs.historyPage.type​

readonly type: "object"

$defs.ping​

readonly ping: Record<string, unknown>

$defs.pollers​

readonly pollers: Record<string, unknown>

$defs.pong​

readonly pong: Record<string, unknown>

$defs.queryRequests​

readonly queryRequests: object

$defs.queryRequests.items​

readonly items: object

$defs.queryRequests.items.additionalProperties​

readonly additionalProperties: false

$defs.queryRequests.items.properties​

readonly properties: object

$defs.queryRequests.items.properties.args​

readonly args: object

$defs.queryRequests.items.properties.name​

readonly name: object

$defs.queryRequests.items.properties.name.maxLength​

readonly maxLength: 256

$defs.queryRequests.items.properties.name.minLength​

readonly minLength: 1

$defs.queryRequests.items.properties.name.type​

readonly type: "string"

$defs.queryRequests.items.properties.queryId​

readonly queryId: object

$defs.queryRequests.items.properties.queryId.maxLength​

readonly maxLength: 256

$defs.queryRequests.items.properties.queryId.minLength​

readonly minLength: 1

$defs.queryRequests.items.properties.queryId.type​

readonly type: "string"

$defs.queryRequests.items.required​

readonly required: readonly ["queryId", "name"]

$defs.queryRequests.items.type​

readonly type: "object"

$defs.queryRequests.type​

readonly type: "array"

$defs.queryResults​

readonly queryResults: object

$defs.queryResults.items​

readonly items: object

$defs.queryResults.items.additionalProperties​

readonly additionalProperties: false

$defs.queryResults.items.properties​

readonly properties: object

$defs.queryResults.items.properties.error​

readonly error: object

$defs.queryResults.items.properties.error.type​

readonly type: "string"

$defs.queryResults.items.properties.queryId​

readonly queryId: object

$defs.queryResults.items.properties.queryId.maxLength​

readonly maxLength: 256

$defs.queryResults.items.properties.queryId.minLength​

readonly minLength: 1

$defs.queryResults.items.properties.queryId.type​

readonly type: "string"

$defs.queryResults.items.properties.rejected​

readonly rejected: object

$defs.queryResults.items.properties.rejected.type​

readonly type: "boolean"

$defs.queryResults.items.properties.value​

readonly value: object

$defs.queryResults.items.required​

readonly required: readonly ["queryId"]

$defs.queryResults.items.type​

readonly type: "object"

$defs.queryResults.type​

readonly type: "array"

$defs.queryTaskRef​

readonly queryTaskRef: object

$defs.queryTaskRef.additionalProperties​

readonly additionalProperties: false

$defs.queryTaskRef.properties​

readonly properties: object

$defs.queryTaskRef.properties.kind​

readonly kind: object

$defs.queryTaskRef.properties.kind.const​

readonly const: "query"

$defs.queryTaskRef.properties.queryTaskId​

readonly queryTaskId: object

$defs.queryTaskRef.properties.queryTaskId.maxLength​

readonly maxLength: 256

$defs.queryTaskRef.properties.queryTaskId.minLength​

readonly minLength: 1

$defs.queryTaskRef.properties.queryTaskId.type​

readonly type: "string"

$defs.queryTaskRef.properties.runId​

readonly runId: object

$defs.queryTaskRef.properties.runId.maxLength​

readonly maxLength: 256

$defs.queryTaskRef.properties.runId.minLength​

readonly minLength: 1

$defs.queryTaskRef.properties.runId.type​

readonly type: "string"

$defs.queryTaskRef.required​

readonly required: readonly ["kind", "runId", "queryTaskId"]

$defs.queryTaskRef.type​

readonly type: "object"

$defs.req​

readonly req: Record<string, unknown>

$defs.res​

readonly res: object

$defs.res.if​

readonly if: object

$defs.res.if.properties​

readonly properties: object

$defs.res.if.properties.ok​

readonly ok: object

$defs.res.if.properties.ok.const​

readonly const: false

$defs.res.if.required​

readonly required: readonly ["ok"]

$defs.res.then​

readonly then: object

$defs.res.then.required​

readonly required: readonly ["error"]

$defs.serviceFrame​

readonly serviceFrame: object

$defs.serviceFrame.oneOf​

readonly oneOf: readonly [{ $ref: "#/$defs/welcome"; }, { $ref: "#/$defs/task"; }, { $ref: "#/$defs/heartbeatAck"; }, { $ref: "#/$defs/cancel"; }, { $ref: "#/$defs/res"; }, { $ref: "#/$defs/pong"; }]

$defs.task​

readonly task: object

$defs.task.oneOf​

readonly oneOf: readonly [Record<string, unknown>, Record<string, unknown>, Record<string, unknown>]

$defs.taskFailed​

readonly taskFailed: object

$defs.taskFailed.oneOf​

readonly oneOf: readonly [Record<string, unknown>, Record<string, unknown>]

$defs.taskRef​

readonly taskRef: object

$defs.taskRef.oneOf​

readonly oneOf: readonly [{ $ref: "#/$defs/workflowTaskRef"; }, { $ref: "#/$defs/queryTaskRef"; }, { $ref: "#/$defs/activityTaskRef"; }]

$defs.taskResult​

readonly taskResult: object

$defs.taskResult.oneOf​

readonly oneOf: readonly [Record<string, unknown>, Record<string, unknown>, Record<string, unknown>]

$defs.welcome​

readonly welcome: Record<string, unknown>

$defs.workerFrame​

readonly workerFrame: object

$defs.workerFrame.oneOf​

readonly oneOf: readonly [{ $ref: "#/$defs/hello"; }, { $ref: "#/$defs/ping"; }, { $ref: "#/$defs/pollers"; }, { $ref: "#/$defs/taskResult"; }, { $ref: "#/$defs/taskFailed"; }, { $ref: "#/$defs/heartbeat"; }, { $ref: "#/$defs/workerHeartbeat"; }, { $ref: "#/$defs/req"; }, { $ref: "#/$defs/bye"; }]

$defs.workerHeartbeat​

readonly workerHeartbeat: Record<string, unknown>

$defs.workflowTaskRef​

readonly workflowTaskRef: object

$defs.workflowTaskRef.additionalProperties​

readonly additionalProperties: false

$defs.workflowTaskRef.properties​

readonly properties: object

$defs.workflowTaskRef.properties.attempt​

readonly attempt: object

$defs.workflowTaskRef.properties.attempt.minimum​

readonly minimum: 1

$defs.workflowTaskRef.properties.attempt.type​

readonly type: "integer"

$defs.workflowTaskRef.properties.expectedHistoryLength​

readonly expectedHistoryLength: object

$defs.workflowTaskRef.properties.expectedHistoryLength.minimum​

readonly minimum: 1

$defs.workflowTaskRef.properties.expectedHistoryLength.type​

readonly type: "integer"

$defs.workflowTaskRef.properties.kind​

readonly kind: object

$defs.workflowTaskRef.properties.kind.const​

readonly const: "workflow"

$defs.workflowTaskRef.properties.runId​

readonly runId: object

$defs.workflowTaskRef.properties.runId.maxLength​

readonly maxLength: 256

$defs.workflowTaskRef.properties.runId.minLength​

readonly minLength: 1

$defs.workflowTaskRef.properties.runId.type​

readonly type: "string"

$defs.workflowTaskRef.properties.taskId​

readonly taskId: object

$defs.workflowTaskRef.properties.taskId.maxLength​

readonly maxLength: 256

$defs.workflowTaskRef.properties.taskId.minLength​

readonly minLength: 1

$defs.workflowTaskRef.properties.taskId.type​

readonly type: "string"

$defs.workflowTaskRef.required​

readonly required: readonly ["kind", "runId", "taskId", "attempt", "expectedHistoryLength"]

$defs.workflowTaskRef.type​

readonly type: "object"

$id​

readonly $id: "https://docs.fluidgrids.ai/schemas/bridge-v2.schema.json"

$schema​

readonly $schema: "https://json-schema.org/draft/2020-12/schema"

description​

readonly description: "Frames between a self-hosted worker and the FluidGrids worker bridge over /runner-bridge (JSON text frames, Bearer fgr_ token of kind WORKER, ping every 20 s, 65 s idle timeout, 10 MiB frame cap). Close codes: 4001 Unauthorized, 4002 Revoked, 4003 Replaced, 4004 ProtocolError, 4008 IdleTimeout, 4009 ShuttingDown, 4010 QuotaExceeded, 4011 QueueNotAllowed, 4012 FeatureDisabled."

oneOf​

readonly oneOf: readonly [{ $ref: "#/$defs/workerFrame"; }, { $ref: "#/$defs/serviceFrame"; }]

title​

readonly title: "FluidGrids worker bridge, protocol 2"