Skip to main content

UGC 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://ugc-service
  • Protobuf File Spec: ugc.proto

Table of Contents

Operations

PUB ugcContent Operation

Accepts one of the following messages:

Message ugcContentUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentobject---additional properties are allowed
payload.ugcContent.contentIdstring----
payload.ugcContent.namespacestring----
payload.ugcContent.channelstring----
payload.ugcContent.userIdstring----
payload.ugcContent.createdTimestring--format (date-time)-
payload.ugcContent.isOfficialboolean----
payload.ugcContent.updatedTimestring--format (date-time)-
payload.ugcContent.tagsarray<string>----
payload.ugcContent.tags (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContent": {
"contentId": "string",
"namespace": "string",
"channel": "string",
"userId": "string",
"createdTime": "2019-08-24T14:15:22Z",
"isOfficial": true,
"updatedTime": "2019-08-24T14:15:22Z",
"tags": [
"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 ugcContentDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentDeleteobject---additional properties are allowed
payload.ugcContentDelete.namespacestring----
payload.ugcContentDelete.contentIdstring----
payload.ugcContentDelete.userIdstring----
payload.ugcContentDelete.deleteBystring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentDelete": {
"namespace": "string",
"contentId": "string",
"userId": "string",
"deleteBy": "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 ugcContentHide

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentHideobject---additional properties are allowed
payload.ugcContentHide.namespacestring----
payload.ugcContentHide.contentIdstring----
payload.ugcContentHide.userIdstring----
payload.ugcContentHide.autoModerationboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentHide": {
"namespace": "string",
"contentId": "string",
"userId": "string",
"autoModeration": 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 ugcContentUnHide

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentHideobject---additional properties are allowed
payload.ugcContentHide.namespacestring----
payload.ugcContentHide.contentIdstring----
payload.ugcContentHide.userIdstring----
payload.ugcContentHide.autoModerationboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentHide": {
"namespace": "string",
"contentId": "string",
"userId": "string",
"autoModeration": 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 ugcContentCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentobject---additional properties are allowed
payload.ugcContent.contentIdstring----
payload.ugcContent.namespacestring----
payload.ugcContent.channelstring----
payload.ugcContent.userIdstring----
payload.ugcContent.createdTimestring--format (date-time)-
payload.ugcContent.isOfficialboolean----
payload.ugcContent.updatedTimestring--format (date-time)-
payload.ugcContent.tagsarray<string>----
payload.ugcContent.tags (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContent": {
"contentId": "string",
"namespace": "string",
"channel": "string",
"userId": "string",
"createdTime": "2019-08-24T14:15:22Z",
"isOfficial": true,
"updatedTime": "2019-08-24T14:15:22Z",
"tags": [
"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 ugcContentLiked

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentLikeobject---additional properties are allowed
payload.ugcContentLike.namespacestring----
payload.ugcContentLike.userIdstring----
payload.ugcContentLike.creatorIdstring----
payload.ugcContentLike.contentIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentLike": {
"namespace": "string",
"userId": "string",
"creatorId": "string",
"contentId": "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 ugcContentUnLiked

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentLikeobject---additional properties are allowed
payload.ugcContentLike.namespacestring----
payload.ugcContentLike.userIdstring----
payload.ugcContentLike.creatorIdstring----
payload.ugcContentLike.contentIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentLike": {
"namespace": "string",
"userId": "string",
"creatorId": "string",
"contentId": "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 ugcChannel Operation

Accepts one of the following messages:

Message ugcChannelCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcChannelobject---additional properties are allowed
payload.ugcChannel.namespacestring----
payload.ugcChannel.channelIdstring----
payload.ugcChannel.userIdstring----
payload.ugcChannel.channelNamestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcChannel": {
"namespace": "string",
"channelId": "string",
"userId": "string",
"channelName": "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 ugcChannelUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcChannelobject---additional properties are allowed
payload.ugcChannel.namespacestring----
payload.ugcChannel.channelIdstring----
payload.ugcChannel.userIdstring----
payload.ugcChannel.channelNamestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcChannel": {
"namespace": "string",
"channelId": "string",
"userId": "string",
"channelName": "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 ugcChannelDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcChannelobject---additional properties are allowed
payload.ugcChannel.namespacestring----
payload.ugcChannel.channelIdstring----
payload.ugcChannel.userIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcChannel": {
"namespace": "string",
"channelId": "string",
"userId": "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 ugcCreator Operation

Accepts one of the following messages:

Message ugcCreatorCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcCreatorobject---additional properties are allowed
payload.ugcCreator.namespacestring----
payload.ugcCreator.userIdstring----
payload.ugcCreator.creatorIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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 ugcCreatorFollowed

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcCreatorobject---additional properties are allowed
payload.ugcCreator.namespacestring----
payload.ugcCreator.userIdstring----
payload.ugcCreator.creatorIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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 ugcCreatorUnFollowed

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcCreatorobject---additional properties are allowed
payload.ugcCreator.namespacestring----
payload.ugcCreator.userIdstring----
payload.ugcCreator.creatorIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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 ugcCreatorDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcCreatorobject---additional properties are allowed
payload.ugcCreator.namespacestring----
payload.ugcCreator.userIdstring----
payload.ugcCreator.creatorIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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 ugcCreatorBanned

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcCreatorBanobject---additional properties are allowed
payload.ugcCreatorBan.namespacestring----
payload.ugcCreatorBan.userIdstring----
payload.ugcCreatorBan.reasonstring----
payload.ugcCreatorBan.typestring----
payload.ugcCreatorBan.enableboolean----
payload.ugcCreatorBan.endDatestring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcCreatorBan": {
"namespace": "string",
"userId": "string",
"reason": "string",
"type": "string",
"enable": true,
"endDate": "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 ugcCreatorUnBanned

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcCreatorBanobject---additional properties are allowed
payload.ugcCreatorBan.namespacestring----
payload.ugcCreatorBan.userIdstring----
payload.ugcCreatorBan.reasonstring----
payload.ugcCreatorBan.typestring----
payload.ugcCreatorBan.enableboolean----
payload.ugcCreatorBan.endDatestring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcCreatorBan": {
"namespace": "string",
"userId": "string",
"reason": "string",
"type": "string",
"enable": true,
"endDate": "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"
}

PUB ugcContentGroup Operation

Accepts one of the following messages:

Message ugcContentGroupCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentGroupobject---additional properties are allowed
payload.ugcContentGroup.namespacestring----
payload.ugcContentGroup.groupIdstring----
payload.ugcContentGroup.namestring----
payload.ugcContentGroup.userIdstring----
payload.ugcContentGroup.contentsarray<string>----
payload.ugcContentGroup.contents (single item)string----
payload.ugcContentGroup.createdTimestring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentGroup": {
"namespace": "string",
"groupId": "string",
"name": "string",
"userId": "string",
"contents": [
"string"
],
"createdTime": "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 ugcContentGroupUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentGroupobject---additional properties are allowed
payload.ugcContentGroup.namespacestring----
payload.ugcContentGroup.groupIdstring----
payload.ugcContentGroup.namestring----
payload.ugcContentGroup.userIdstring----
payload.ugcContentGroup.contentsarray<string>----
payload.ugcContentGroup.contents (single item)string----
payload.ugcContentGroup.createdTimestring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentGroup": {
"namespace": "string",
"groupId": "string",
"name": "string",
"userId": "string",
"contents": [
"string"
],
"createdTime": "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 ugcContentGroupDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.ugcContentGroupobject---additional properties are allowed
payload.ugcContentGroup.namespacestring----
payload.ugcContentGroup.groupIdstring----
payload.ugcContentGroup.namestring----
payload.ugcContentGroup.userIdstring----
payload.ugcContentGroup.contentsarray<string>----
payload.ugcContentGroup.contents (single item)string----
payload.ugcContentGroup.createdTimestring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"ugcContentGroup": {
"namespace": "string",
"groupId": "string",
"name": "string",
"userId": "string",
"contents": [
"string"
],
"createdTime": "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"
}