WikiPageUnpublishedPayload wiki.page.unpublished@1
Generated at from
openvibe-contracts v0.33.0 and
openvibe-sdk v0.5.0.
- Version
- 1.0.0
- Owner
- wiki
- Visibility
- first-party
- Status
- active
- Compatibility
- backward
- Schema
https://openvibe.network/contracts/events/payloads/wiki.page.unpublished.v1.json
wiki.page.unpublished v1 (OpenVibe.Wiki server/wiki/service.js sync, via openvibe-publishing/index-hooks publicationEvent). Emitted when a published page stopped being published, 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 wiki.index_document.*). Envelope: subject { type: page, id: pg_…, revision: <published revision, 0 if none> }, visibility internal, priority important, actor the person or service:wiki (scheduled and system changes).
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
canonical_url | string | null | yes | null: the event carries a tombstone, which has no URL. | |
publication_state | const | yes |
| |
indexability | object | null | yes | The last gate decision, or null when there is none. | |
space | string | yes | Space slug. |
|
slug | string | yes | Page slug inside the space. |
|
visibility | enum | yes | Effective visibility (the page's, narrowed by its space's). |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: tombstone
{
"canonical_url": null,
"publication_state": "unpublished",
"indexability": {
"decision": "index",
"reasons": []
},
"space": "food",
"slug": "ramen",
"visibility": "public"
}Rejected: wrong-state
{
"canonical_url": null,
"publication_state": "published",
"indexability": null,
"space": "food",
"slug": "ramen",
"visibility": "public"
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('wiki.page.unpublished@1', value); // { valid, errors: [{ path, message }] }