ShareTransferView share.transfer-view@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
network
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/share/transfer-view.v1.json

share.transfer-view@1: the pending transfer in the GET body, with its recipient as a person. The transfer id is what the sheet sends back.

Fields

FieldTypeRequiredDescriptionConstraints
idstringyes
  • format uuid
fromidentity.subject-refyes
toshare.personyes
keep_accessbooleanyes
  • default false
requested_atstringyes
  • format date-time
expires_atstringyes
  • format date-time
stateenumyes
  • one of "pending", "accepted", "declined", "cancelled", "expired"

Examples

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

Valid: example
{
  "id": "00000000-0000-4000-8000-000000000002",
  "from": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "to": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
    },
    "username": "maticus",
    "display_name": "Maticus",
    "avatar_url": null
  },
  "keep_access": false,
  "requested_at": "2026-11-06T00:10:00Z",
  "expires_at": "2026-11-13T00:10:00Z",
  "state": "pending"
}
Rejected: bare-to
{
  "id": "00000000-0000-4000-8000-000000000002",
  "from": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "to": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
  },
  "keep_access": false,
  "requested_at": "2026-11-06T00:10:00Z",
  "expires_at": "2026-11-13T00:10:00Z",
  "state": "pending"
}

Validate

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