AsyncAPI for currency service 0.0.1 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:currency
- Protobuf File Spec: currency.proto
- Default content type: application/json
Table of Contents
Operations
PUB currencyManagement
Operation
Accepts one of the following messages:
Message currencyCreated
message is sent when currency is created
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.currency | object | - | - | - | additional properties are allowed |
payload.currency.currencyCode | string | currency code | - | - | - |
payload.currency.localizationDescriptions | object | localized description | - | - | - |
payload.currency.localizationDescriptions (additional properties) | string | - | - | - | - |
payload.currency.currencySymbol | string | currency symbol | - | - | - |
payload.currency.namespace | string | namespace | - | - | - |
payload.currency.currencyType | string | currency type | allowed ("REAL" , "VIRTUAL" ) | - | - |
payload.currency.decimals | integer | decimals, commonly set 2 if real currency or 0 if virtual currency | - | format (int32 ) | - |
payload.currency.createdAt | string | - | - | format (date-time ) | - |
payload.currency.updatedAt | string | - | - | format (date-time ) | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | event id | - | - | - |
version | integer | - | - | - | - |
name | string | event name | - | - | - |
namespace | string | event namespace | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | client id | - | - | - |
userId | string | the operator id | - | - | - |
traceId | string | trace id | - | - | - |
sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"currency": {
"currencyCode": "string",
"localizationDescriptions": {
"property1": "string",
"property2": "string"
},
"currencySymbol": "string",
"namespace": "string",
"currencyType": "REAL",
"decimals": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"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 currencyUpdated
message is sent when currency is updated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.currency | object | - | - | - | additional properties are allowed |
payload.currency.currencyCode | string | currency code | - | - | - |
payload.currency.localizationDescriptions | object | localized description | - | - | - |
payload.currency.localizationDescriptions (additional properties) | string | - | - | - | - |
payload.currency.currencySymbol | string | currency symbol | - | - | - |
payload.currency.namespace | string | namespace | - | - | - |
payload.currency.currencyType | string | currency type | allowed ("REAL" , "VIRTUAL" ) | - | - |
payload.currency.decimals | integer | decimals, commonly set 2 if real currency or 0 if virtual currency | - | format (int32 ) | - |
payload.currency.createdAt | string | - | - | format (date-time ) | - |
payload.currency.updatedAt | string | - | - | format (date-time ) | - |
payload.oldCurrency | object | - | - | - | additional properties are allowed |
payload.oldCurrency.currencyCode | string | currency code | - | - | - |
payload.oldCurrency.localizationDescriptions | object | localized description | - | - | - |
payload.oldCurrency.localizationDescriptions (additional properties) | string | - | - | - | - |
payload.oldCurrency.currencySymbol | string | currency symbol | - | - | - |
payload.oldCurrency.namespace | string | namespace | - | - | - |
payload.oldCurrency.currencyType | string | currency type | allowed ("REAL" , "VIRTUAL" ) | - | - |
payload.oldCurrency.decimals | integer | decimals, commonly set 2 if real currency or 0 if virtual currency | - | format (int32 ) | - |
payload.oldCurrency.createdAt | string | - | - | format (date-time ) | - |
payload.oldCurrency.updatedAt | string | - | - | format (date-time ) | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | event id | - | - | - |
version | integer | - | - | - | - |
name | string | event name | - | - | - |
namespace | string | event namespace | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | client id | - | - | - |
userId | string | the operator id | - | - | - |
traceId | string | trace id | - | - | - |
sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"currency": {
"currencyCode": "string",
"localizationDescriptions": {
"property1": "string",
"property2": "string"
},
"currencySymbol": "string",
"namespace": "string",
"currencyType": "REAL",
"decimals": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"oldCurrency": {
"currencyCode": "string",
"localizationDescriptions": {
"property1": "string",
"property2": "string"
},
"currencySymbol": "string",
"namespace": "string",
"currencyType": "REAL",
"decimals": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"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 currencyDeleted
message is sent when currency is deleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.currency | object | - | - | - | additional properties are allowed |
payload.currency.currencyCode | string | currency code | - | - | - |
payload.currency.localizationDescriptions | object | localized description | - | - | - |
payload.currency.localizationDescriptions (additional properties) | string | - | - | - | - |
payload.currency.currencySymbol | string | currency symbol | - | - | - |
payload.currency.namespace | string | namespace | - | - | - |
payload.currency.currencyType | string | currency type | allowed ("REAL" , "VIRTUAL" ) | - | - |
payload.currency.decimals | integer | decimals, commonly set 2 if real currency or 0 if virtual currency | - | format (int32 ) | - |
payload.currency.createdAt | string | - | - | format (date-time ) | - |
payload.currency.updatedAt | string | - | - | format (date-time ) | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | event id | - | - | - |
version | integer | - | - | - | - |
name | string | event name | - | - | - |
namespace | string | event namespace | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | client id | - | - | - |
userId | string | the operator id | - | - | - |
traceId | string | trace id | - | - | - |
sessionId | string | session id | - | - | - |
Examples of payload (generated)
{
"payload": {
"currency": {
"currencyCode": "string",
"localizationDescriptions": {
"property1": "string",
"property2": "string"
},
"currencySymbol": "string",
"namespace": "string",
"currencyType": "REAL",
"decimals": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}