SharePerson share.person@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/person.v1.json
share.person@1: a person in a sharing answer, from Network's identity projection. username, display_name and avatar_url are null when Network does not know the subject (or reports it banned or deleted).
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
subject | identity.subject-ref | yes | ||
username | string | null | yes | ||
display_name | string | null | yes | ||
avatar_url | string | null | yes |
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: example
{
"subject": {
"type": "user",
"id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
},
"username": "maticus",
"display_name": "Maticus",
"avatar_url": "https://cdn.openvibe.network/avatars/maticus.png"
}Valid: unknown
{
"subject": {
"type": "user",
"id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
},
"username": null,
"display_name": null,
"avatar_url": null
}Rejected: missing-username
{
"subject": {
"type": "user",
"id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
},
"display_name": "Maticus",
"avatar_url": null
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('share.person@1', value); // { valid, errors: [{ path, message }] }