ToolsJobCreateRequest tools.job-create-request@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
tools
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/tools/job-create-request.v1.json

tools.job-create-request@1: the request of tools.job.create on the Tools satellites that run jobs. POST /api/v1/jobs: tools.job-request@1 (JSON or multipart). POST /api/v1/jobs/:id/retry and PUT|DELETE /api/v1/jobs/:id/references/:ref take no body.

Fields

This schema has no named fields.

Examples

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

Valid: retry
{}
Valid: submit
{
  "type": "img.process",
  "input": {
    "tool": "convert",
    "format": "webp",
    "quality": 80
  }
}
Rejected: text
"img.process"

Validate

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