TipsModerationRequest tips.moderation-request@1

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

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

tips.moderation-request@1: bodies of tips.interaction.moderate on OpenVibe.Tips. POST /api/v1/interactions/:id/hide and /restore: { reason? } (at most 200 characters, kept in the moderation log). GET /api/v1/moderation?creator=&state=held|hidden|visible|all&cursor=&limit= and GET /api/v1/moderation/log?creator= take no body. The creator, one of their moderators, or a service holding the capability moderates (the log is for the creator and services). Hide and restore need an Idempotency-Key header (as every write). Refusals are problem+json: 404 tips.interaction_not_found, 403 tips.forbidden or capability.denied, 422 tips.text_too_long.

Fields

This schema has no named fields.

Examples

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

Valid: hide
{
  "reason": "spam link"
}
Valid: no-body
{}
Rejected: reason-too-long
{
  "reason": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Validate

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