Mindwm API 0.1.0

This document describes the documentation, a collection of JSON schemas and example cloudevent and payloads

Servers

  • unixsocket:///tmp/mindwm-asciinema-{MINDWM_UUID}.socket/unixsocketasciinema

    Asciinema

    object
    USER_HOST
    required
    string
    Default value:"localhost"
    • #client
  • unixsocket:///tmp/mindwm-asciinema-{MINDWM_UUID}.socket/unixsocketmindwm-client

    Mindwm Client

    object
    USER_HOSTNAME
    required
    string
    Default value:"localhost"
    • #client
    • #docker
  • http://broker-ingress.{KNATIVE_EVENTING_NS}.svc.cluster.local/httpknative-eventing

    Knative eventing

    object
    KNATIVE_EVENTING_NS
    required
    string

    Namespace where Knative Eventing is deployed

    Default value:"knative-eventing"
    • #kubernetes
  • http://webhook.{KNATIVE_SERVING_NS}.svc.cluster.local:8008/httpknative-serving

    Knative serving

    object
    KNATIVE_SERVING_NS
    required
    string

    Namespace where Knative Serving is deployed

    Default value:"knative-eventing"
    • #kubernetes
  • kafka://neo4j-cdc.${KAFKA_NS}:9093/kafkakafka

    Kafka cluster

    object
    KAFKA_NS
    required
    string

    Namespace where kafka broker is deployed

    Default value:"redpanda"
    Security:
    security.protocol:PLAINTEXT
    • #kubernetes
  • bolt://{CONTEXT_NAME}-neo4j.context-{CONTEXT_NAME}:7687/boltneo4j-cdc-plugin

    Neo4j Change data capture plugin

    object
    CONTEXT_NAME
    required
    string

    context name

    • #kubernetes
  • http://{CONTEXT_NAME}-vector-headless.{CONTEXT_NAME}:80/httpvector

    Vector.dev

    object
    CONTEXT_NAME
    required
    string

    context name

    • #kubernetes
  • nats://{address}:{port}/natsnats

    Nats Server

    object
    address
    required
    string
    Default value:"nats.nats"
      Allowed values:
    • "10.20.30.211"
    • "nats.nats"
    port
    required
    string
    Default value:"4222"
      Allowed values:
    • "31101"
    • "4222"
    Security:
    • User/Password
    • #kubernetes

Operations

  • SEND /tmp/mindwm-asciinema-{MINDWM_UUID}.socket

    Operation IDIoDocument

    Available only on servers:

    Accepts the following message:

    IoDocument

    Basic IoDocument produced by mindwm-client

    Message IDIoDocument
    object
      Examples values:
    • {"input":"uptime","output":"16:37:51 up 19 days, 2:15, 71 users, load average: 2.01, 2.85, 2.95","ps1":"user@mindwm-dev1:~/rnd/asyncapi$"}

    Examples

  • SEND mindwm.{USER}.{HOSTNAME}.tmux.{TMUX_SOCKET}.{MINDWM_UUID}.{TMUX_ID}.{TMUX_PANE_ID}.iodocument

    Operation IDIoDocumentEvent

    Available only on servers:

    Accepts the following message:

    IoDocument

    TmuxPaneIoDocument in cloudevent

    Message IDIoDocument
    restricted any allOf

    Examples

  • SEND mindwm.{USER}.{HOSTNAME}.clipboard

    Operation IDClipboardEvent

    Available only on servers:

    Accepts the following message:

    ClipboardEvent

    Clipboard

    Message IDClipboardEvent
    restricted any allOf

    Examples

  • SEND mindwm.{USER}.{HOSTNAME}.touch

    Operation IDTouchEvent

    Available only on servers:

    Accepts the following message:

    TouchEvent

    update atime

    Message IDTouchEvent
    restricted any allOf

    Examples

Messages

  • #1IoDocument

    Basic IoDocument produced by mindwm-client

    Message IDIoDocument
    object
      Examples values:
    • {"input":"uptime","output":"16:37:51 up 19 days, 2:15, 71 users, load average: 2.01, 2.85, 2.95","ps1":"user@mindwm-dev1:~/rnd/asyncapi$"}
  • #2IoDocumentEvent

    TmuxPaneIoDocument in cloudevent

    Message IDIoDocumentEvent
    restricted any allOf
  • #3Clipboard

    Clipboard data

    Message IDClipboard
    restricted any
  • #4ClipboardEvent

    Clipboard

    Message IDClipboardEvent
    restricted any allOf
  • #5TouchEvent

    update atime

    Message IDTouchEvent
    restricted any allOf
  • #6ChangeDataCapture

    Change Data Capture

    Message IDChangeDataCapture
    object

Schemas

  • restricted any allOf
  • restricted any allOf
  • restricted any allOf
  • restricted any
  • object
  • object
      Examples values:
    • {"input":"uptime","output":"16:37:51 up 19 days, 2:15, 71 users, load average: 2.01, 2.85, 2.95","ps1":"user@mindwm-dev1:~/rnd/asyncapi$"}
  • object
  • object
  • object
  • object
      Examples values:
    • {"headers":{},"message_key":"\"45-0\"","meta":{"operation":"created","source":{"hostname":"team-a-neo4j-0"},"timestamp":1718125560033,"txEventId":0,"txEventsCount":1,"txId":45,"username":"neo4j"},"offset":9,"partition":0,"payload":{"after":{"labels":["IoDocument"],"properties":{"output":"17:05:52 up 1 day, 23:03, 2 users, load average: 1.23, 1.71, 2.16\n","ps1":"bebebeko@mcmp6:~/poc-mindwm-dev$","time":1718125560.028501,"user_input":"uptime","uuid":"dcb8deaf-8f00-4b77-a8f2-77ec7d20a429"}},"before":"","id":"9","type":"node"},"schema":{"constraints":{},"properties":{"output":"String","ps1":"String","time":"Double","user_input":"String","uuid":"String"}},"source_type":"kafka","timestamp":"2024-06-11T17:06:00.428Z","topic":"team-a-cdc-topic"}
  • object
      Examples values:
    • {"headers":{},"message_key":"\"46-0\"","meta":{"operation":"created","source":{"hostname":"team-a-neo4j-0"},"timestamp":1718125560435,"txEventId":0,"txEventsCount":1,"txId":46,"username":"neo4j"},"offset":10,"partition":0,"payload":{"after":{"properties":{}},"before":"","end":{"id":"9","ids":{},"labels":["IoDocument"]},"id":"8","label":"HAS_IO_DOCUMENT","start":{"id":"4","ids":{},"labels":["TmuxPane"]},"type":"relationship"},"schema":{"constraints":{},"properties":{}},"source_type":"kafka","timestamp":"2024-06-11T17:06:00.438Z","topic":"team-a-cdc-topic"}