Lobby Friends Events 0.1.0 documentation
info
In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.
- Specification ID:
http://lobby-friends-service - Protobuf File Spec: friends.proto
Table of Contents
Operations
PUB friendRequests Operation
Accepts one of the following messages:
Message friendRequestSent
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.relation | object | - | - | - | additional properties are allowed |
| payload.relation.userId | string | - | - | format (uuid) | - |
| payload.relation.friendId | string | - | - | format (uuid) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | UserId of the operator for this event (optional) | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
| spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
Message friendRequestCancelled
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.relation | object | - | - | - | additional properties are allowed |
| payload.relation.userId | string | - | - | format (uuid) | - |
| payload.relation.friendId | string | - | - | format (uuid) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | UserId of the operator for this event (optional) | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
| spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
Message friendRemoved
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.relation | object | - | - | - | additional properties are allowed |
| payload.relation.userId | string | - | - | format (uuid) | - |
| payload.relation.friendId | string | - | - | format (uuid) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | UserId of the operator for this event (optional) | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
| spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
Message friendAddedBulk
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.relation | object | - | - | - | additional properties are allowed |
| payload.relation.userId | string | - | - | format (uuid) | - |
| payload.relation.friendId | string | - | - | format (uuid) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | UserId of the operator for this event (optional) | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
| spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
PUB incomingFriendRequests Operation
Accepts one of the following messages:
Message friendRequestAccepted
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.relation | object | - | - | - | additional properties are allowed |
| payload.relation.userId | string | - | - | format (uuid) | - |
| payload.relation.friendId | string | - | - | format (uuid) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | UserId of the operator for this event (optional) | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
| spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
Message friendRequestRejected
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.relation | object | - | - | - | additional properties are allowed |
| payload.relation.userId | string | - | - | format (uuid) | - |
| payload.relation.friendId | string | - | - | format (uuid) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | UserId of the operator for this event (optional) | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
| spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}