BotRobotManageRequest bot.robot-manage-request@1

Generated at from openvibe-contracts v0.97.0 and openvibe-sdk v0.26.0.

Version
1.0.0
Owner
bot
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/bot/robot-manage-request.v1.json

bot.robot-manage-request@1: bodies of bot.robot.manage on OpenVibe.Bot. POST /api/v1/robots → { owner (the person a service acts for), name, profile_id, access_policy?, limits? }; PATCH …/robots/:id → { name?, access_policy?, limits? }; POST …/robots/:id/operators → { subject, role? (operator by default) }. POST …/robots/:id/pairing-code and both DELETE routes 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: create
{
  "owner": "usr_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
  "name": "Rover",
  "profile_id": "adeept.adr036",
  "access_policy": "queue"
}
Valid: operator
{
  "subject": "usr_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
  "role": "viewer"
}
Rejected: owner-role
{
  "subject": "usr_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
  "role": "owner"
}

Validate

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