BotRobotReadRequest bot.robot-read-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
Decision
ADR-043
Schema
https://openvibe.network/contracts/bot/robot-read-request.v1.json

bot.robot-read-request@1: the query of bot.robot.read on OpenVibe.Bot (server/api/v1.js); the routes take no body. owner names whose robots GET /api/v1/robots lists (a service must give it; a person may give only their own subject). limit (1 to 200, default 50) and before (the last audit id seen) page GET …/robots/:id/audit.

Fields

FieldTypeRequiredDescriptionConstraints
ownerstring
  • pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$
limitinteger
  • minimum 1
  • maximum 200
beforeinteger
  • minimum 1

Examples

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

Valid: audit-page
{
  "limit": 50,
  "before": 1200
}
Valid: list
{
  "owner": "usr_01J8Z4P7T3W9Y1AC5N8R0S4V6X"
}
Rejected: limit-too-high
{
  "limit": 500
}
Rejected: unknown-field
{
  "owner": "usr_01J8Z4P7T3W9Y1AC5N8R0S4V6X",
  "include": "devices"
}

Validate

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