BlogDeleteResult blog.delete-result@1

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

Version
1.0.0
Owner
blog
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/blog/delete-result.v1.json

blog.delete-result@1: the answer of DELETE /api/v1/posts/:id on OpenVibe.Blog (blog.post.delete): { deleted: true, id }.

Fields

FieldTypeRequiredDescriptionConstraints
deletedconstyes
  • = true
idstringyes

Examples

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

Valid: deleted
{
  "deleted": true,
  "id": "pst_01JAB2C3D4E5F6G7H8J9K0MNPQ"
}
Rejected: not-deleted
{
  "deleted": false,
  "id": "x"
}

Validate

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