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
  • PUB report

Operations

PUB autoModeration Operation

Message hideContent

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.autoHideContent	object	-	-	-	additional properties are allowed
payload.autoHideContent.namespace	string	-	-	-	-
payload.autoHideContent.userId	string	-	-	-	-
payload.autoHideContent.contentId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.Category	string	-	-	-	-
payload.Comment	string	-	-	-	-
payload.CreatedAt	string	-	-	format (date-time)	-
payload.ExtensionCategory	string	-	-	-	-
payload.ID	string	-	-	-	-
payload.Namespace	string	-	-	-	-
payload.ObjectID	string	-	-	-	-
payload.ObjectType	string	-	-	-	-
payload.Reason	string	-	-	-	-
payload.ReporterID	string	-	-	-	-
payload.TicketID	string	-	-	-	-
payload.UpdatedAt	string	-	-	format (date-time)	-
payload.UserID	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.Category	string	-	-	-	-
payload.Comment	string	-	-	-	-
payload.CreatedAt	string	-	-	format (date-time)	-
payload.ExtensionCategory	string	-	-	-	-
payload.ID	string	-	-	-	-
payload.Namespace	string	-	-	-	-
payload.ObjectID	string	-	-	-	-
payload.ObjectType	string	-	-	-	-
payload.Reason	string	-	-	-	-
payload.ReporterID	string	-	-	-	-
payload.TicketID	string	-	-	-	-
payload.UpdatedAt	string	-	-	format (date-time)	-
payload.UserID	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

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"
}