WikiPublishRequest wiki.publish-request@1

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

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

wiki.publish-request@1: bodies of wiki.revision.publish on OpenVibe.Wiki (editors). POST /api/v1/pages/:id/publish: { revision? } (default the head; an AI revision needs a person's approval first). POST /api/v1/pages/:id/schedule: { run_at, revision? } (ISO 8601). POST /api/v1/pages/:id/revisions/:n/review and POST /api/v1/proposals/:id/review: { decision: approved | rejected, note?, publish? } (a person; a proposal is published on approval unless publish is false). POST /api/v1/pages/:id/unpublish takes 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: publish
{
  "revision": 3
}
Valid: review
{
  "decision": "approved",
  "note": "checked the sources",
  "publish": true
}
Rejected: bad-decision
{
  "decision": "maybe",
  "revision": 0
}

Validate

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