numo-labs / schema

:snowflake: json schema definitions for numo-labs

schema

JSON schema definitions for numo-labs.

Federated search

For Federated search, we will use streaming services. These streaming asynchronous services will pass messages between client and server and between the different micro-services in the federated search stack.

Base Message format (envelope)

{
  "header": {
    "messageId": "afb99815-0004-4530-8581-a4aaffb92904",
    "messageType": "package.v1",
    "x-correlationId": "afb99815-0004-4530-8581-a4aaffb92904",
    "x-cliendId": "75010105537365102704845373651050168024",
    "x-connectionId": "8t6GMkJAmgkws6qVAGCL"
  },
  "body": {
    "foo":"a",
    "__bar":"b"
  }
}

Each message MUST be wrapped in the above envelope and MUST contain a few basic fields.

Header section:

• messageId: (Required) A client side generated unique id.
• messageType: (Required) Type of message here for exapmple a searchRequest message.
• x-correlationId: (Optional) A client side generated unique id and through the stack forwarded message, which can be used so correlated returned messages back to the request.
• x-clientId: (Optional) In case of a request, we need a client Id to be able to send messages back to the correct client
• x-connectionId: (Optional) In case of a request, we need a connection Id to be able to send messages back to the correct connection for the client, we assume the client can have multiple connections open to the same server.

Message Section:

• body: the body of the message,

all body attributes starting with __ will be filtered out when send to the client, in our example __bar will be removed. 

Federated Search Messages

Requests

• Federated Search Message