Fediversity API -- Centrifugo events 0.1.0
  • EUPL-1.2

Pub/sub channels published by fediversity-api and subscribed to by front-ends (such as the panel) via Centrifugo. RPC over HTTP is described by openapi.json instead.

Servers

  • wss://{host}/connection/websocketwssproduction

    Centrifugo WebSocket endpoint

    object
    string
    required

    Centrifugo hostname (usually events.<panel-domain>)

Operations

  • RECEIVE fediversity.builds.{build_id}

    Progress and lifecycle events for a specific build.

    Subscribe to builds events

    Operation IDreceive_builds

    Available only on servers:

    object
    build_idstring
    required

    Unique build identifier

    Accepts the following message:

    Message IDevent
    oneOf

    Examples

  • RECEIVE fediversity.deployments.{deployment_id}

    State change events for a deployment.

    Subscribe to deployments events

    Operation IDreceive_deployments

    Available only on servers:

    object
    deployment_idstring
    required

    Operator-namespaced deployment identifier ({username}/{pk})

    Accepts the following message:

    Message IDevent
    object [DeploymentStateEventPayload]

    Examples

Messages

  • #1
    Message IDBuildEvent
    oneOf
  • #2
    Message IDDeploymentStateEvent
    object [DeploymentStateEventPayload]

Schemas

  • object [BuildEventCanceled]
  • object [BuildEventCanceledData]
  • object [BuildEventCompleted]
  • object [BuildEventCompletedData]
  • object [BuildEventFailed]
  • object [BuildEventFailedData]
  • object [BuildEventProgress]
  • object [BuildEventProgressData]
  • object [BuildEventQueued]
  • object [BuildEventQueuedData]
  • object [BuildEventStarted]
  • object [BuildEventStartedData]
  • oneOf
  • object [DeploymentStateEventPayload]