Lobby Chat 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-chat-service - Protobuf File Spec: chat.proto
Table of Contents
Operations
PUB personalChat Operation
Message personalChatSent
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.chat | object | - | - | - | additional properties are allowed |
| payload.chat.messageId | string | - | - | format (uuid) | - |
| payload.chat.senderId | string | - | - | format (uuid) | - |
| payload.chat.targetId | string | Can be partyId or userId | - | format (uuid) | - |
| payload.chat.payload | string | - | - | - | - |
| 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": {
"chat": {
"messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
"senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
"targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
"payload": "string"
}
},
"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 partyChat Operation
Message partyChatSent
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.chat | object | - | - | - | additional properties are allowed |
| payload.chat.messageId | string | - | - | format (uuid) | - |
| payload.chat.senderId | string | - | - | format (uuid) | - |
| payload.chat.targetId | string | Can be partyId or userId | - | format (uuid) | - |
| payload.chat.payload | string | - | - | - | - |
| 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": {
"chat": {
"messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
"senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
"targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
"payload": "string"
}
},
"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"
}