Skip to main content

Basic Service Namespace 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.

Table of Contents

Operations

PUB namespace Operation

Accepts one of the following messages:

Message namespaceCreated

message is sent when namespace is created

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.parentNamespacestringparent namespace in multi tenant mode---
payload.displayNamestringdisplay name---
payload.createdAtstringtime when namespace was created-format (date-time)-
payload.statusbooleanstatus---
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": {
"namespace": "string",
"parentNamespace": "string",
"displayName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": 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 namespaceDeleted

message is sent when namespace is deleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.parentNamespacestringparent namespace in multi tenant mode---
payload.displayNamestringdisplay name---
payload.createdAtstringtime when namespace was created-format (date-time)-
payload.statusbooleanstatus---
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": {
"namespace": "string",
"parentNamespace": "string",
"displayName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": 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 namespaceEnabled

message is sent when namespace is enabled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.parentNamespacestringparent namespace in multi tenant mode---
payload.displayNamestringdisplay name---
payload.createdAtstringtime when namespace was created-format (date-time)-
payload.statusbooleanstatus---
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": {
"namespace": "string",
"parentNamespace": "string",
"displayName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": 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 namespaceDisabled

message is sent when namespace is disabled

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.parentNamespacestringparent namespace in multi tenant mode---
payload.displayNamestringdisplay name---
payload.createdAtstringtime when namespace was created-format (date-time)-
payload.statusbooleanstatus---
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": {
"namespace": "string",
"parentNamespace": "string",
"displayName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": 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 namespaceDisplayNameUpdated

message is sent when display name is udpated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.parentNamespacestringparent namespace in multi tenant mode---
payload.displayNamestringdisplay name---
payload.createdAtstringtime when namespace was created-format (date-time)-
payload.statusbooleanstatus---
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": {
"namespace": "string",
"parentNamespace": "string",
"displayName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": 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"
}