Cloudsave 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://cloudsave-service
• Protobuf File Spec: cloudsave.proto
• Default content type: application/json

Table of Contents

• Operations
  • PUB adminGameRecord
  • PUB gameRecord
  • PUB adminPlayerRecord
  • PUB playerRecord

Operations

PUB adminGameRecord Operation

Accepts one of the following messages:

Message adminGameRecordCreated

message is sent when the new Admin Game Record is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
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": {
    "key": "string",
    "namespace": "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 adminGameRecordUpdated

message is sent when the Admin Game Record is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
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": {
    "key": "string",
    "namespace": "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 adminGameRecordDeleted

message is sent when the Admin Game Record is deleted

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
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": {
    "key": "string",
    "namespace": "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"
}

PUB gameRecord Operation

Accepts one of the following messages:

Message gameRecordCreated

message is sent when the new Game Record is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object allOf	-	-	-	additional properties are allowed
payload.setBy	string	-	-	-	-
payload.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.0.key	string	record key	-	-	-
payload.0.namespace	string	namespace of the record	-	-	-
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": {
    "setBy": "string",
    "key": "string",
    "namespace": "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 gameRecordUpdated

message is sent when the Game Record is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object allOf	-	-	-	additional properties are allowed
payload.setBy	string	-	-	-	-
payload.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.0.key	string	record key	-	-	-
payload.0.namespace	string	namespace of the record	-	-	-
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": {
    "setBy": "string",
    "key": "string",
    "namespace": "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 gameRecordDeleted

message is sent when the Game Record is deleted

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
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": {
    "key": "string",
    "namespace": "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"
}

PUB adminPlayerRecord Operation

Accepts one of the following messages:

Message adminPlayerRecordCreated

message is sent when the Admin Player Record is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
payload.userId	string	record user id	-	-	-
payload.actorUserId	string	requester user id	-	-	-
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": {
    "key": "string",
    "namespace": "string",
    "userId": "string",
    "actorUserId": "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 adminPlayerRecordUpdated

message is sent when the Admin Player Record is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
payload.userId	string	record user id	-	-	-
payload.actorUserId	string	requester user id	-	-	-
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": {
    "key": "string",
    "namespace": "string",
    "userId": "string",
    "actorUserId": "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 adminPlayerRecordDeleted

message is sent when the Admin Player Record is deleted

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
payload.userId	string	record user id	-	-	-
payload.actorUserId	string	requester user id	-	-	-
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": {
    "key": "string",
    "namespace": "string",
    "userId": "string",
    "actorUserId": "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"
}

PUB playerRecord Operation

Accepts one of the following messages:

Message playerRecordCreated

message is sent when the Player Record is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
payload.userId	string	record user id	-	-	-
payload.actorUserId	string	requester user id	-	-	-
payload.isPublic	boolean	type of the player record	-	-	-
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": {
    "key": "string",
    "namespace": "string",
    "userId": "string",
    "actorUserId": "string",
    "isPublic": true
  },
  "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 playerRecordUpdated

message is sent when the Player Record is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
payload.userId	string	record user id	-	-	-
payload.actorUserId	string	requester user id	-	-	-
payload.isPublic	boolean	type of the player record	-	-	-
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": {
    "key": "string",
    "namespace": "string",
    "userId": "string",
    "actorUserId": "string",
    "isPublic": true
  },
  "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 playerRecordDeleted

message is sent when the Player Record is deleted.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.key	string	record key	-	-	-
payload.namespace	string	namespace of the record	-	-	-
payload.userId	string	record user id	-	-	-
payload.actorUserId	string	requester user id	-	-	-
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": {
    "key": "string",
    "namespace": "string",
    "userId": "string",
    "actorUserId": "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"
}