Skip to main content

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 Operation

Message userContentUrlCreated

message is sent when generate upload url

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.simpleEventobject---additional properties are allowed
payload.simpleEvent.urlstringupload url---
payload.simpleEvent.accessUrlstringaccess url---
payload.simpleEvent.methodstringmethod, default PUT---
payload.simpleEvent.contentTypestringcontent type---
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": {
"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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.countryGroupobject---additional properties are allowed
payload.countryGroup.codestringcountry group code---
payload.countryGroup.namestringcountry group name---
payload.countriesarray<object>----
payload.countries.codestring----
payload.countries.namestring----
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": {
"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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.countryGroupobject---additional properties are allowed
payload.countryGroup.codestringcountry group code---
payload.countryGroup.namestringcountry group name---
payload.countriesarray<object>----
payload.countries.codestring----
payload.countries.namestring----
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": {
"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"
}