RentIndexDocumentUpsertedPayload rent.index_document.upserted@1

Generated at from openvibe-contracts v0.131.0 and openvibe-sdk v0.38.0.

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

rent.index_document.upserted v1 (OpenVibe.Rent server/search-index.js, via openvibe-publishing/search-feed). The OpenVibe.Search document of a rental listing page (type listing, /listings/<id>): title, description, price and period, city, region, country and neighbourhood (never a street address or the contact link). Sent in the transaction that created, edited, renewed, hid or removed the listing, and by the sweep (server/search-index.js); a listing that is hidden, removed or past its expiry becomes a tombstone. The sequencer (rent_index_revisions) gives an unchanged document its old revision and nothing is sent. Always visibility public and publication_state published; a page its own robots mark noindex stays in Search as a noindex document. Facets: kind, country, city, currency, period, bedrooms. Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type: listing, id, revision: <document revision> }, visibility internal, actor service:rent.

Fields

This schema has no named fields.

Examples

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

Valid: listing-noindex
{
  "owner": "rent",
  "type": "listing",
  "id": "rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 5,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.rent/listings/rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "title": "Bright room near the park",
  "summary": "650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "body": "Bright room near the park\n650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "facets": {
    "kind": "room",
    "country": "GB",
    "city": "Leeds",
    "currency": "GBP",
    "period": "month",
    "bedrooms": "1"
  },
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-09T12:00:00.000Z",
  "updated_at": "2026-10-10T08:00:00.000Z",
  "indexability": {
    "decision": "noindex",
    "reasons": [
      "owner_decision"
    ]
  }
}
Valid: listing
{
  "owner": "rent",
  "type": "listing",
  "id": "rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 2,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.rent/listings/rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "title": "Bright room near the park",
  "summary": "650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "body": "Bright room near the park\n650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "facets": {
    "kind": "room",
    "country": "GB",
    "city": "Leeds",
    "currency": "GBP",
    "period": "month",
    "bedrooms": "1"
  },
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-09T12:00:00.000Z",
  "updated_at": "2026-10-10T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Rejected: bad-id
{
  "owner": "rent",
  "type": "listing",
  "id": "lst_1",
  "revision": 2,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.rent/listings/rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "title": "Bright room near the park",
  "summary": "650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "body": "Bright room near the park\n650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "facets": {
    "kind": "room",
    "country": "GB",
    "city": "Leeds",
    "currency": "GBP",
    "period": "month",
    "bedrooms": "1"
  },
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-09T12:00:00.000Z",
  "updated_at": "2026-10-10T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Rejected: other-owner
{
  "owner": "deals",
  "type": "listing",
  "id": "rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 2,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.rent/listings/rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "title": "Bright room near the park",
  "summary": "650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "body": "Bright room near the park\n650 GBP a month · Leeds, Headingley · available from 2026-11-01",
  "facets": {
    "kind": "room",
    "country": "GB",
    "city": "Leeds",
    "currency": "GBP",
    "period": "month",
    "bedrooms": "1"
  },
  "authorship": "human",
  "provenance": [],
  "publication_state": "published",
  "published_at": "2026-10-09T12:00:00.000Z",
  "updated_at": "2026-10-10T08:00:00.000Z",
  "indexability": {
    "decision": "index",
    "reasons": []
  }
}
Rejected: tombstone-as-upsert
{
  "owner": "rent",
  "type": "listing",
  "id": "rnt_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "revision": 3,
  "deleted": true
}

Validate

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