BlogPostDeletedPayload blog.post.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.post.deleted.v1.json

blog.post.deleted v1 (OpenVibe.Blog server/domain/publication.js afterChange, via openvibe-publishing/index-hooks publicationEvent). Emitted when a post was soft-deleted, in the transaction of the change. For subscribers other than Search: canonical URL, publication state and Search-shaped indexability, never the body (Search gets that from blog.index_document.*). Envelope: subject { type: post, id: pst_…, revision: <published revision, 0 if none> }, visibility internal, priority important, actor the person or service:blog (scheduled and system changes).

Fields

FieldTypeRequiredDescriptionConstraints
canonical_urlstring | nullyesnull: the event carries a tombstone, which has no URL.
publication_stateconstyes
  • = "deleted"
indexabilityobject | nullyesThe last gate decision, or null when there is none.
blogobjectyes
  • no other fields
blog.idstringyes
  • pattern ^blg_[0-9A-HJKMNP-TV-Z]{26}$
blog.handlestringyes
  • pattern ^[a-z0-9][a-z0-9_-]{1,39}$
visibilityenumyesThe post's own visibility (members = entitlement-gated).
  • one of "public", "unlisted", "members", "private"

Examples

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

Valid: tombstone
{
  "canonical_url": null,
  "publication_state": "deleted",
  "indexability": null,
  "blog": {
    "id": "blg_01JAB2C3D4E5F6G7H8J9K0MNPT",
    "handle": "alex"
  },
  "visibility": "members"
}
Rejected: unpublished-state
{
  "canonical_url": null,
  "publication_state": "unpublished",
  "indexability": null,
  "blog": {
    "id": "blg_01JAB2C3D4E5F6G7H8J9K0MNPT",
    "handle": "alex"
  },
  "visibility": "members"
}

Validate

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