Skip to main content

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

Table of Contents

Operations

PUB autoModeration Operation

Message hideContent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.autoHideContentobject---additional properties are allowed
payload.autoHideContent.namespacestring----
payload.autoHideContent.userIdstring----
payload.autoHideContent.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": {
"autoHideContent": {
"namespace": "string",
"userId": "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 report Operation

Accepts one of the following messages:

Message userReport

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.Categorystring----
payload.Commentstring----
payload.CreatedAtstring--format (date-time)-
payload.ExtensionCategorystring----
payload.IDstring----
payload.Namespacestring----
payload.ObjectIDstring----
payload.ObjectTypestring----
payload.Reasonstring----
payload.ReporterIDstring----
payload.TicketIDstring----
payload.UpdatedAtstring--format (date-time)-
payload.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": {
"Category": "string",
"Comment": "string",
"CreatedAt": "2019-08-24T14:15:22Z",
"ExtensionCategory": "string",
"ID": "string",
"Namespace": "string",
"ObjectID": "string",
"ObjectType": "string",
"Reason": "string",
"ReporterID": "string",
"TicketID": "string",
"UpdatedAt": "2019-08-24T14:15:22Z",
"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"
}

Message adminReport

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.Categorystring----
payload.Commentstring----
payload.CreatedAtstring--format (date-time)-
payload.ExtensionCategorystring----
payload.IDstring----
payload.Namespacestring----
payload.ObjectIDstring----
payload.ObjectTypestring----
payload.Reasonstring----
payload.ReporterIDstring----
payload.TicketIDstring----
payload.UpdatedAtstring--format (date-time)-
payload.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": {
"Category": "string",
"Comment": "string",
"CreatedAt": "2019-08-24T14:15:22Z",
"ExtensionCategory": "string",
"ID": "string",
"Namespace": "string",
"ObjectID": "string",
"ObjectType": "string",
"Reason": "string",
"ReporterID": "string",
"TicketID": "string",
"UpdatedAt": "2019-08-24T14:15:22Z",
"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"
}