NetworkFriendCircle network.friend-circle@1
Generated at from
openvibe-contracts v0.443.0 and
openvibe-sdk v0.177.0.
- Version
- 1.0.0
- Owner
- network
- Visibility
- first-party
- Status
- active
- Compatibility
- backward
- Schema
https://openvibe.network/contracts/network/friend-circle.v1.json
network.friend-circle@1 (plan §AB.51; the owner, 11-14: "implement the friend system so it can be used across sites … synced with your network account … SDK and API … send and request … make your own UIs"). GET /api/v1/me/friends on OpenVibe.Network: the person's friends in one read. Adding is one direction; two people are friends when both have added each other. mutual: friends; requests: they added you, you have not added them; asked: you added them, they have not added you. friends: whom you added (both mutual and asked), kept for older readers. Online people first in each list. A block on either side removes the person from every list.
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
subject | string | yes | The person reading. |
|
friends | array of object | yes |
| |
friends[].subject | string | yes |
| |
mutual | array of object | yes |
| |
mutual[].subject | string | yes |
| |
mutual[].username | string | null | yes |
| |
mutual[].display_name | string | null | yes |
| |
mutual[].avatar_url | string | null |
| ||
mutual[].online | boolean | yes | Seen on an OpenVibe site in the last few minutes (Network's presence). | |
mutual[].site | string | null | Where they are, when online and they share it. |
| |
mutual[].since | string | null | When this side of the friendship last changed. |
| |
requests | array of object | yes |
| |
requests[].subject | string | yes |
| |
requests[].username | string | null | yes |
| |
requests[].display_name | string | null | yes |
| |
requests[].avatar_url | string | null |
| ||
requests[].online | boolean | yes | Seen on an OpenVibe site in the last few minutes (Network's presence). | |
requests[].site | string | null | Where they are, when online and they share it. |
| |
requests[].since | string | null | When this side of the friendship last changed. |
| |
asked | array of object | yes |
| |
asked[].subject | string | yes |
| |
asked[].username | string | null | yes |
| |
asked[].display_name | string | null | yes |
| |
asked[].avatar_url | string | null |
| ||
asked[].online | boolean | yes | Seen on an OpenVibe site in the last few minutes (Network's presence). | |
asked[].site | string | null | Where they are, when online and they share it. |
| |
asked[].since | string | null | When this side of the friendship last changed. |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: circle
{
"subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GH",
"friends": [
{
"subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GJ"
}
],
"mutual": [
{
"subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GJ",
"username": "ada",
"display_name": "Ada",
"avatar_url": "https://openvibe.network/avatar/ada?s=80",
"online": true,
"site": "openvibe.live",
"since": "2026-11-14T08:00:00.000Z"
}
],
"requests": [],
"asked": []
}Rejected: no-mutual
{
"subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GH",
"friends": [],
"requests": [],
"asked": []
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('network.friend-circle@1', value); // { valid, errors: [{ path, message }] }