Mariner server

Implementation

Documentation is available as part of generated API reference:

• Python hat.mariner.server module

JSON Schema definitions

$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "hat-mariner://server.yaml"
title: Mariner Server
description: Mariner Server's configuration
type: object
required:
    - name
    - mariner
    - eventer
    - clients
properties:
    type:
        const: mariner
        description: configuration type identification
    version:
        type: string
        description: component version
    log:
        $ref: "hat-json://logging.yaml"
    name:
        type: string
        description: component name
    mariner:
        type: object
        required:
            - host
            - port
        properties:
            host:
                type: string
                default: "127.0.0.1"
            port:
                type: integer
                default: 23014
    eventer:
        type: object
        required:
            - host
            - port
            - token
        properties:
            host:
                type: string
                default: "127.0.0.1"
            port:
                type: integer
                default: 23012
            token:
                type:
                    - 'null'
                    - string
    clients:
        type: array
        items:
            type: object
            required:
                - name
                - token
                - subscriptions
                - register_events
            properties:
                name:
                    type: string
                token:
                    type:
                        - 'null'
                        - string
                subscriptions:
                    $ref: "hat-mariner://server.yaml#/$defs/event_types"
                register_events:
                    type: array
                    items:
                        type: object
                        required:
                            - subscriptions
                        properties:
                            subscriptions:
                                $ref: "hat-mariner://server.yaml#/$defs/event_types"
                            schema_id:
                                type: string
    schemas:
        type: array
        items:
            type: object
$defs:
    event_types:
        type: array
        items:
            type: array
            items:
                type: string