Skip to content

PubSubInternalMessageBusSpec

Maaike edited this page Aug 23, 2024 · 9 revisions

wis2box Pub/Sub Internal Message Bus micro-specification

Overview

To support wis2box event driven architecture (EDA), this document describes the topic structure and payload.

Topics and payload

topic payload
wis2box/notifications WIS2 Notification Message (WNM)
wis2box/storage S3 notification JSON format (?)
wis2box/data_mappings/refresh None/empty
wis2box/dataset/publication WMO Core Metadata Profile 2 (WCMP2)
wis2box/dataset/unpublication/{metadata_id} None/empty
wis2box/data/publication custom payload for data-publication
wis2box/data/unpublication/{data_id} None/empty
wis2box/cap/publication custom payload for CAP-publication

Custom payloads

Data publication

type: object
properties:
    metadata_id:
        type: string
        description: metadata_id for the dataset
    channel:
        type: string
        description: topic to publish data
    data:
        type: string
        description: data payload
        contentEncoding: base64
    filename:
        type: string
        description: name of file
    _meta:
        type: object
        description: WMO tools `_meta` format
required:
    - metadata_id
    - channel
    - data
    - filename
    - _meta

CAP publication

type: object
properties:
    metadata_id:
        type: string
        description: metadata_id for the dataset
    data:
        type: string
        description: data payload
        contentEncoding: base64
    filename:
        type: string
        description: name of file
required:
    - metadata_id
    - data
    - filename