InventoryItemUnequippedPayload inventory.item.unequipped@1

Generated at from openvibe-contracts v0.127.0 and openvibe-sdk v0.37.0.

Version
1.0.0
Owner
inventory
Visibility
first-party
Status
active
Compatibility
backward
Decision
ADR-054
Schema
https://openvibe.network/contracts/events/payloads/inventory.item.unequipped.v1.json

inventory.item.unequipped v1 (OpenVibe.Inventory, ADR-054). A person cleared a slot. Envelope: subject { type: user, id: owner }, visibility public.

Fields

FieldTypeRequiredDescriptionConstraints
kindstringyes
  • pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)+$
slotstringyes
  • pattern ^[a-z][a-z0-9_]{0,31}$
ownerstringyes
  • pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$

Examples

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

Valid: example
{
  "kind": "live.hat",
  "slot": "hat",
  "owner": "usr_01JZ0000000000000000000AAA"
}
Rejected: missing-field
{
  "slot": "hat",
  "owner": "usr_01JZ0000000000000000000AAA"
}

Validate

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