Config Service Events 0.1.0 documentation
Published Messages (commonConfiguration)
The service publishes one of these messages below.
commonConfigurationCreated
This message is sent when common configuration is created. Contains fields from event and the following payload.
Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"isPublic": true
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| namespace | string | Namespace of the config |
| key | string | Key of the config |
| value | string | Value of the config |
| isPublic | boolean | Flag to indicates whether the config visible for public users |
commonConfigurationUpdated
This message is sent when common configuration is updated. Contains fields from event and the following payload.
Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"previousValue": "string",
"isPublic": true
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| namespace | string | Namespace of the config |
| key | string | Key of the config |
| value | string | New value of the config after the update |
| previousValue | string | Value of the config before the update |
| isPublic | boolean | Flag to indicates whether the config visible for public users |
commonConfigurationDeleted
This message is sent when common configuration is deleted. Contains fields from event and the following payload.
Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"isPublic": true
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| namespace | string | Namespace of the config |
| key | string | Key of the config |
| value | string | Value of the config at the time of deletion |
| isPublic | boolean | Flag to indicates whether the config visible for public users |
Published Messages (restrictedConfiguration)
The service publishes one of these messages below.
restrictedConfigurationCreated
This message is sent when restricted configuration is created. Contains fields from event and the following payload.
Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"category": "INTERNAL"
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| namespace | string | Namespace of the config |
| key | string | Key of the config |
| value | string | Value of the config |
| category | string | Intended usage category of the config |
restrictedConfigurationUpdated
This message is sent when restricted configuration is updated. Contains fields from event and the following payload.
Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"previousValue": "string",
"category": "INTERNAL"
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| namespace | string | Namespace of the config |
| key | string | Key of the config |
| value | string | New value of the config after the update |
| previousValue | string | Value of the config before the update |
| category | string | Intended usage category of the config |
restrictedConfigurationDeleted
This message is sent when restricted configuration is deleted. Contains fields from event and the following payload.
Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"category": "INTERNAL"
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}
payload
| Name | Type | Description |
|---|---|---|
| namespace | string | Namespace of the config |
| key | string | Key of the config |
| value | string | Value of the config at the time of deletion |
| category | string | Intended usage category of the config |
Schemas
event
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID for this event instance |
| version | integer | Event schema version (e.g. 1 or 2) - distinguishes payload structure revisions for the same event name |
| name | string | Event name - identifies what happened |
| timestamp | string (date-time) | Timestamp when the event was published |
| namespace | string | The namespace of the resource. |
| clientId | string | The OAuth2 clientId that issued the access token of the actor |
| userId | string | The actor's userId, empty if the action is triggered using client credentials |
| parentNamespace | string | The actor's publisher/studio namespace that triggers the action. Old field version, refer to 'unionNamespace' for newer one. |
| unionNamespace | string | The actor's publisher/studio namespace that triggers the action |
| traceId | string | Distributed trace ID for correlating logs/spans across services |
| sessionId | string | - |