AsyncAPI for reward service 0.1.0 documentation

• Protobuf File Spec: ecommerce.proto

Published Messages (rewardManagement)

The service publishes one of these messages below.

rewardCreated

Message is sent when reward is created. Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
rewardManage	rewardManage	-

rewardUpdated

Message is sent when reward is updated. Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
rewardManage	rewardManage	-

rewardDeleted

Message is sent when reward is deleted. Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
rewardManage	rewardManage	-

rewardImported

Message is sent when import reward configuration. Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
rewardImport	object	-

payload.rewardImport

Name	Type	Description
namespace	string	namespace
replacedRewardCodes	array	list of replaced reward codes
ignoredRewardCodes	array	list of ignored reward codes
newRewardCodes	array	list of new reward codes
failedRewardCodes	array	list of failed reward codes

Schemas

rewardManage

Name	Type	Description
namespace	string	namespace
rewardCode	string	reward code
description	string	reward description
eventTopic	string	topic to listen to

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	-
traceId	string	-
sessionId	string	-