Achievement Service 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://achievement-service
• Protobuf File Spec: achievement.proto

Table of Contents

• Operations
  • PUB achievement

Operations

PUB achievement Operation

Accepts one of the following messages:

Message userAchievementUnlocked

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userAchievement	object	-	-	-	additional properties are allowed
payload.userAchievement.userId	string	-	-	-	-
payload.userAchievement.namespace	string	-	-	-	-
payload.userAchievement.achievementCode	string	-	-	-	-
payload.userAchievement.status	integer	-	-	-	-
payload.userAchievement.achievedAt	integer	-	-	-	-
payload.userAchievement.statCode	string	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema1"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "userAchievement": {
      "userId": "string",
      "namespace": "string",
      "achievementCode": "string",
      "status": 0,
      "achievedAt": 0,
      "statCode": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message globalAchievementUnlocked

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.globalAchievement	object	-	-	-	additional properties are allowed
payload.globalAchievement.achievementCode	string	-	-	-	-
payload.globalAchievement.namespace	string	-	-	-	-
payload.globalAchievement.status	integer	-	-	-	-
payload.globalAchievement.achievedAt	integer	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema2"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "globalAchievement": {
      "achievementCode": "string",
      "namespace": "string",
      "status": 0,
      "achievedAt": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message achievementRewardClaimed

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.achievementRewardClaimed	object	-	-	-	additional properties are allowed
payload.achievementRewardClaimed.userId	string	-	-	-	-
payload.achievementRewardClaimed.achievementCode	string	-	-	-	-
payload.achievementRewardClaimed.namespace	string	-	-	-	-
payload.achievementRewardClaimed.status	integer	-	-	-	-
payload.achievementRewardClaimed.achievement	integer	-	-	-	-
payload.achievementRewardClaimed.claimedAt	integer	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema3"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "achievementRewardClaimed": {
      "userId": "string",
      "achievementCode": "string",
      "namespace": "string",
      "status": 0,
      "achievement": 0,
      "claimedAt": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}