BlogIndexDocumentDeletedPayload blog.index_document.deleted@1

Generated at from openvibe-contracts v0.33.0 and openvibe-sdk v0.5.0.

Version
1.0.0
Owner
blog
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/events/payloads/blog.index_document.deleted.v1.json

blog.index_document.deleted v1 (OpenVibe.Blog server/domain/publication.js syncIndex, via openvibe-publishing/index-hooks indexEvent). A Search tombstone: the post is no longer published, public and listable, so Search drops it at this revision or older. Only sent for a post Search was sent before. Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type: post, id, revision }, visibility internal, priority important, actor service:blog.

Fields

FieldTypeRequiredDescriptionConstraints
typeconstyes
  • = "post"
idstringyes
  • pattern ^pst_[0-9A-HJKMNP-TV-Z]{26}$
revisionintegeryesIndex revision of the tombstone; wins over any document at the same or an older revision.
  • minimum 1
  • maximum 9007199254740991

Examples

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

Valid: tombstone
{
  "type": "post",
  "id": "pst_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "revision": 3
}
Rejected: wrong-type
{
  "type": "page",
  "id": "pst_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "revision": 3
}

Validate

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