Basic Service Util 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://basic-service
• Protobuf File Spec: util.proto

Table of Contents

• Operations
  • PUB userContent
  • PUB countryGroup

Operations

PUB userContent Operation

Message userContentUrlCreated

message is sent when generate upload url

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.simpleEvent	object	-	-	-	additional properties are allowed
payload.simpleEvent.url	string	upload url	-	-	-
payload.simpleEvent.accessUrl	string	access url	-	-	-
payload.simpleEvent.method	string	method, default PUT	-	-	-
payload.simpleEvent.contentType	string	content type	-	-	-
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": {
    "simpleEvent": {
      "url": "string",
      "accessUrl": "string",
      "method": "string",
      "contentType": "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 countryGroup Operation

Accepts one of the following messages:

Message countryGroupCreated

message is sent when add a country group

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.countryGroup	object	-	-	-	additional properties are allowed
payload.countryGroup.code	string	country group code	-	-	-
payload.countryGroup.name	string	country group name	-	-	-
payload.countries	array<object>	-	-	-	-
payload.countries.code	string	-	-	-	-
payload.countries.name	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": {
    "countryGroup": {
      "code": "string",
      "name": "string"
    },
    "countries": [
      {
        "code": "string",
        "name": "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 countryGroupUpdated

message is sent when country group is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.countryGroup	object	-	-	-	additional properties are allowed
payload.countryGroup.code	string	country group code	-	-	-
payload.countryGroup.name	string	country group name	-	-	-
payload.countries	array<object>	-	-	-	-
payload.countries.code	string	-	-	-	-
payload.countries.name	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": {
    "countryGroup": {
      "code": "string",
      "name": "string"
    },
    "countries": [
      {
        "code": "string",
        "name": "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"
}