CodesTask codes.task@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

An older major, still in the catalog. The current one is codes.task@2.
Version
1.1.0
Owner
codes
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/codes/task.v1.json

codes.task@1: a coding task on OpenVibe.Codes, as GET /api/v1/tasks/:id answers it (capability codes.task.read) and POST /api/v1/tasks creates it. STATE follows the OpenVibe.Run job that carries it: queued (waiting for one of the person's machines), placed, running, then succeeded, failed, cancelled or expired (no machine of theirs took it in time). URL is the task's page on openvibe.codes, where its owner follows it live. RESULT is present once it has ended: OK says whether the agents finished, SUMMARY what they said, FILES and PATCH the change (the patch at most 256 KiB, PATCH_TRUNCATED when cut), PUSH where it went when asked, COST_USD the model use on the person's own keys, DURATION_MS the time on their machine. ERROR says why a task that never ran ended (Run refused it, or the job failed before a result).

Fields

FieldTypeRequiredDescriptionConstraints
idstringyesThe Codes task id (tsk_ + ULID).
  • pattern ^tsk_[0-9A-HJKMNP-TV-Z]{26}$
stateenumyes
  • one of "queued", "placed", "running", "succeeded", "failed", "cancelled", "expired"
repostringyes
  • maxLength 300
refstring | null
  • maxLength 200
agentstring | null
  • maxLength 41
urlstringyes
  • pattern ^https://
  • format uri
created_atstringyes
  • format date-time
updated_atstringyes
  • format date-time
errorstring | null
  • maxLength 1000
resultobject
  • no other fields
result.okbooleanyes
result.agentsarray of string
  • maxItems 20
  • items: maxLength 41
result.summarystring
  • maxLength 4000
result.filesarray of object
  • maxItems 2000
  • items: no other fields
result.files[].pathstringyes
  • minLength 1
  • maxLength 500
result.files[].addedinteger | null
  • minimum 0
result.files[].removedinteger | null
  • minimum 0
result.patchstring
  • maxLength 262144
result.patch_truncatedboolean
result.pushobject
  • no other fields
result.push.pushedbooleanyes
result.push.branchstring
  • maxLength 200
result.push.branch_urlstring
  • format uri
result.push.pull_requeststring
  • format uri
result.push.pull_request_errorstring
  • maxLength 500
result.push.reasonstring
  • maxLength 500
result.cost_usdnumber
  • minimum 0
result.duration_msinteger
  • minimum 0
result.errorstring
  • maxLength 1000
actor_refobject | nullThe OpenVibe.Actor task and step that started this coding task, when it came from Actor.

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

The fixtures that ship with the package are the current major's.

Validate

const contracts = require('openvibe-contracts');
contracts.validate('codes.task@1', value);   // { valid, errors: [{ path, message }] }