AsyncAPI for reward service 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:
urn:net:accelbyte:platform:reward - Protobuf File Spec: reward.proto
Table of Contents
Operations
PUB rewardManagement Operation
Accepts one of the following messages:
Message rewardCreated
message is sent when reward is created
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.rewardManage | object | - | - | - | additional properties are allowed |
| payload.rewardManage.namespace | string | namespace | - | - | - |
| payload.rewardManage.rewardCode | string | reward code | - | - | - |
| payload.rewardManage.description | string | reward description | - | - | - |
| payload.rewardManage.eventTopic | string | topic to listen to | - | - | - |
| 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 | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"rewardManage": {
"namespace": "string",
"rewardCode": "string",
"description": "string",
"eventTopic": "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"
}
Message rewardUpdated
message is sent when reward is updated
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.rewardManage | object | - | - | - | additional properties are allowed |
| payload.rewardManage.namespace | string | namespace | - | - | - |
| payload.rewardManage.rewardCode | string | reward code | - | - | - |
| payload.rewardManage.description | string | reward description | - | - | - |
| payload.rewardManage.eventTopic | string | topic to listen to | - | - | - |
| 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 | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"rewardManage": {
"namespace": "string",
"rewardCode": "string",
"description": "string",
"eventTopic": "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"
}
Message rewardDeleted
message is sent when reward is deleted
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.rewardManage | object | - | - | - | additional properties are allowed |
| payload.rewardManage.namespace | string | namespace | - | - | - |
| payload.rewardManage.rewardCode | string | reward code | - | - | - |
| payload.rewardManage.description | string | reward description | - | - | - |
| payload.rewardManage.eventTopic | string | topic to listen to | - | - | - |
| 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 | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"rewardManage": {
"namespace": "string",
"rewardCode": "string",
"description": "string",
"eventTopic": "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"
}
Message rewardImported
message is sent when import reward configuration
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.rewardImport | object | - | - | - | additional properties are allowed |
| payload.rewardImport.namespace | string | namespace | - | - | - |
| payload.rewardImport.replacedRewardCodes | array<string> | list of replaced reward codes | - | - | - |
| payload.rewardImport.replacedRewardCodes (single item) | string | - | - | - | - |
| payload.rewardImport.ignoredRewardCodes | array<string> | list of ignored reward codes | - | - | - |
| payload.rewardImport.ignoredRewardCodes (single item) | string | - | - | - | - |
| payload.rewardImport.newRewardCodes | array<string> | list of new reward codes | - | - | - |
| payload.rewardImport.newRewardCodes (single item) | string | - | - | - | - |
| payload.rewardImport.failedRewardCodes | array<string> | list of failed reward codes | - | - | - |
| payload.rewardImport.failedRewardCodes (single item) | 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 | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"rewardImport": {
"namespace": "string",
"replacedRewardCodes": [
"string"
],
"ignoredRewardCodes": [
"string"
],
"newRewardCodes": [
"string"
],
"failedRewardCodes": [
"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"
}