Skip to main content

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.rewardManageobject---additional properties are allowed
payload.rewardManage.namespacestringnamespace---
payload.rewardManage.rewardCodestringreward code---
payload.rewardManage.descriptionstringreward description---
payload.rewardManage.eventTopicstringtopic to listen to---
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.rewardManageobject---additional properties are allowed
payload.rewardManage.namespacestringnamespace---
payload.rewardManage.rewardCodestringreward code---
payload.rewardManage.descriptionstringreward description---
payload.rewardManage.eventTopicstringtopic to listen to---
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.rewardManageobject---additional properties are allowed
payload.rewardManage.namespacestringnamespace---
payload.rewardManage.rewardCodestringreward code---
payload.rewardManage.descriptionstringreward description---
payload.rewardManage.eventTopicstringtopic to listen to---
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.rewardImportobject---additional properties are allowed
payload.rewardImport.namespacestringnamespace---
payload.rewardImport.replacedRewardCodesarray<string>list of replaced reward codes---
payload.rewardImport.replacedRewardCodes (single item)string----
payload.rewardImport.ignoredRewardCodesarray<string>list of ignored reward codes---
payload.rewardImport.ignoredRewardCodes (single item)string----
payload.rewardImport.newRewardCodesarray<string>list of new reward codes---
payload.rewardImport.newRewardCodes (single item)string----
payload.rewardImport.failedRewardCodesarray<string>list of failed reward codes---
payload.rewardImport.failedRewardCodes (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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"
}