Content Management Events 0.0.1 documentation
備考
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://content-management-service
Table of Contents
Operations
PUB contentManagement Operation
Accepts one of the following messages:
Message contentManagementArticleCreated
message is sent when article is created
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.articleCreated | object | - | - | - | additional properties are allowed |
| payload.articleCreated.id | string | article id | - | format (uuid) | - |
| payload.articleCreated.title | string | article title | - | - | - |
| payload.articleCreated.rawContent | string | article content in raw format | - | - | - |
| payload.articleCreated.htmlContent | string | article content in HTML format | - | - | - |
| payload.articleCreated.slug | string | article slug | - | - | - |
| payload.articleCreated.status | string | article published status | allowed ("PUBLISHED", "DRAFT") | - | - |
| payload.articleCreated.topicId | string | article topic id | - | - | - |
| payload.articleCreated.metaTitle | string | article meta title | - | - | - |
| payload.articleCreated.metaDescription | string | article meta description | - | - | - |
| payload.articleCreated.namespace | string | namespace | - | - | - |
| payload.articleCreated.createdAt | string | article creation date | - | format (date-time) | - |
| payload.articleCreated.updatedAt | string | article updated date | - | format (date-time) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"articleCreated": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"rawContent": "string",
"htmlContent": "string",
"slug": "string",
"status": "PUBLISHED",
"topicId": "string",
"metaTitle": "string",
"metaDescription": "string",
"namespace": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
Message contentManagementArticleUpdated
message is sent when article is updated
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.articleUpdated | object | - | - | - | additional properties are allowed |
| payload.articleUpdated.id | string | article id | - | format (uuid) | - |
| payload.articleUpdated.title | string | article title | - | - | - |
| payload.articleUpdated.rawContent | string | article content in raw format | - | - | - |
| payload.articleUpdated.htmlContent | string | article content in HTML format | - | - | - |
| payload.articleUpdated.slug | string | article slug | - | - | - |
| payload.articleUpdated.status | string | article published status | allowed ("PUBLISHED", "DRAFT") | - | - |
| payload.articleUpdated.topicId | string | article topic id | - | - | - |
| payload.articleUpdated.metaTitle | string | article meta title | - | - | - |
| payload.articleUpdated.metaDescription | string | article meta description | - | - | - |
| payload.articleUpdated.namespace | string | namespace | - | - | - |
| payload.articleUpdated.createdAt | string | article creation date | - | format (date-time) | - |
| payload.articleUpdated.updatedAt | string | article updated date | - | format (date-time) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"articleUpdated": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"rawContent": "string",
"htmlContent": "string",
"slug": "string",
"status": "PUBLISHED",
"topicId": "string",
"metaTitle": "string",
"metaDescription": "string",
"namespace": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
Message contentManagementArticleDeleted
message is sent when article is deleted
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.articleDeleted | object | - | - | - | additional properties are allowed |
| payload.articleDeleted.id | string | article id | - | - | - |
| payload.articleDeleted.namespace | string | namespace | - | - | - |
| payload.articleDeleted.title | string | article title | - | - | - |
| payload.articleDeleted.slug | string | article slug | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"articleDeleted": {
"id": "string",
"namespace": "string",
"title": "string",
"slug": "string"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
Message contentManagementTopicCreated
message is sent when topic is created
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.topicCreated | object | - | - | - | additional properties are allowed |
| payload.topicCreated.id | string | topic id | - | format (uuid) | - |
| payload.topicCreated.name | string | topic name | - | - | - |
| payload.topicCreated.slug | string | topic slug | - | - | - |
| payload.topicCreated.status | string | topic visibility status | allowed ("VISIBLE", "HIDDEN") | - | - |
| payload.topicCreated.icon | string | topic icon | - | - | - |
| payload.topicCreated.displayOrder | integer | topic display order | - | - | - |
| payload.topicCreated.namespace | string | namespace | - | - | - |
| payload.topicCreated.createdAt | string | topic creation date | - | format (date-time) | - |
| payload.topicCreated.updatedAt | string | topic updated date | - | format (date-time) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"topicCreated": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"status": "VISIBLE",
"icon": "string",
"displayOrder": 0,
"namespace": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
Message contentManagementTopicUpdated
message is sent when topic is updated
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.topicUpdated | object | - | - | - | additional properties are allowed |
| payload.topicUpdated.id | string | topic id | - | format (uuid) | - |
| payload.topicUpdated.name | string | topic name | - | - | - |
| payload.topicUpdated.slug | string | topic slug | - | - | - |
| payload.topicUpdated.status | string | topic visibility status | allowed ("VISIBLE", "HIDDEN") | - | - |
| payload.topicUpdated.icon | string | topic icon | - | - | - |
| payload.topicUpdated.displayOrder | integer | topic display order | - | - | - |
| payload.topicUpdated.namespace | string | namespace | - | - | - |
| payload.topicUpdated.createdAt | string | topic creation date | - | format (date-time) | - |
| payload.topicUpdated.updatedAt | string | topic updated date | - | format (date-time) | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"topicUpdated": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"status": "VISIBLE",
"icon": "string",
"displayOrder": 0,
"namespace": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
Message contentManagementTopicDeleted
message is sent when topic is deleted
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.topicDeleted | object | - | - | - | additional properties are allowed |
| payload.topicDeleted.id | string | topic id | - | - | - |
| payload.topicDeleted.namespace | string | namespace | - | - | - |
| payload.topicDeleted.name | string | topic name | - | - | - |
| payload.topicDeleted.slug | string | topic slug | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"topicDeleted": {
"id": "string",
"namespace": "string",
"name": "string",
"slug": "string"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
Message contentManagementSupportEmailSent
message is sent on support email sent event
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.supportEmailSent | object | - | - | - | additional properties are allowed |
| payload.supportEmailSent.subject | string | email subject | - | - | - |
| payload.supportEmailSent.displayName | string | email display name | - | - | - |
| payload.supportEmailSent.fromPlayerEmail | string | player email address | - | format (email) | - |
| payload.supportEmailSent.toAdminEmail | string | admin email address | - | format (email) | - |
| payload.supportEmailSent.templateIdAdmin | string | admin template id | - | - | - |
| payload.supportEmailSent.templateIdPlayer | string | player template id | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| clientId | string | event client id | - | - | - |
| name | string | event name | - | - | - |
| namespace | string | namespace | - | - | - |
| version | integer | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
Examples of payload (generated)
{
"payload": {
"supportEmailSent": {
"subject": "string",
"displayName": "string",
"fromPlayerEmail": "user@example.com",
"toAdminEmail": "user@example.com",
"templateIdAdmin": "string",
"templateIdPlayer": "string"
}
},
"clientId": "string",
"name": "string",
"namespace": "string",
"version": 0,
"timestamp": "2019-08-24T14:15:22Z"
}