AgentReport agent.report@1

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

Version
1.0.0
Owner
actor
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/agent/report.v1.json

Executor report. A PR alone is not ready; a draft is blocked. human_action carries exactly one question unchanged to the person.

Fields

FieldTypeRequiredDescriptionConstraints
ticket_idstringyes
  • minLength 1
assignment_idstringyes
  • minLength 1
stateenumyes
  • one of "progress", "waiting", "ready", "blocked", "failed", "dropped"
summarystringyes
  • minLength 1
prstring | nullyes
  • format uri
tests_runarray of stringyes
  • items: minLength 1
risksarray of stringyes
  • items: minLength 1
human_actionobject
  • no other fields
human_action.questionstringyes
  • minLength 1

Examples

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

Valid: dropped
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "dropped",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": []
}
Valid: example
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "blocked",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": [],
  "human_action": {
    "question": "Which target?"
  }
}
Valid: failed
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "failed",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": []
}
Valid: progress
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "progress",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": []
}
Valid: ready
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "ready",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": []
}
Valid: waiting
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "waiting",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": []
}
Rejected: human_action
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "blocked",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": [],
  "human_action": {
    "question": "one",
    "second_question": "two"
  }
}
Rejected: state
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "done",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": [],
  "human_action": {
    "question": "Which target?"
  }
}
Rejected: unknown
{
  "ticket_id": "tkt_1",
  "assignment_id": "asn_1",
  "state": "blocked",
  "summary": "Need a target",
  "pr": null,
  "tests_run": [],
  "risks": [],
  "human_action": {
    "question": "Which target?"
  },
  "unexpected": true
}

Validate

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