Skip to content
Server-side backend for Matrix Visualisations
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Use `Future`s Jun 27, 2019
.gitignore
Cargo.toml
README.md

README.md

Matrix Visualisations backend

This backend allows Matrix Visualisations to directly communicate with the PostgreSQL database of Synapse.

Warning

This is a prototype and there is no authentication system to prevent anyone from retrieving any events from the database linked to it. So please do not use this with an homeserver in production.

HTTP REST API

Get every of the deepest (i.e. with the maximum depth) events of a room.

  • HTTP request path: /visualisations/deepest/{roomId}
  • Query parameters: nothing.
  • Response format: a JSON object with a field events containing the array of the JSON bodies of the events.

Get ancestors of a set of events.

  • HTTP request path: /visualisations/ancestors/{roomId}
  • Query parameters:
    • from: a comma separated list of the IDs of the events from which to get the ancestors
    • limit: the maximum number of events to return
  • Response format: a JSON object with a field “events” containing the array of the JSON bodies of the events. Or an error 404 if the room does not exist.

Get descendants of a set of events.

  • HTTP request path: /visualisations/descendants/{roomId}
  • Query parameters:
    • from: a comma separated list of the IDs of the events from which to get the ancestors
    • limit: the maximum number of events to return
  • Response format: a JSON object with a field “events” containing the array of the JSON bodies of the events. Or an error 404 if the room does not exist.
You can’t perform that action at this time.