Do we want a JSON API?

[JanKoppe]

Looking at the new UI, we could easily leverage the internal state agent to provide detailed information about the capture agent. A neat way to do that would be to expose the states via a simple API that can also be used in monitoring. A simple /status.json would be a good start.

Thinking further, one might want to be able to manually start and stop recording remotely, because scheduling via Opencast is not comfortable if you don't know how long you actually want to record for yet.

My gut instinct would be to do it right the first time and build a small and simple JSON API (https://jsonapi.org). But this would again increase the scope, but also the functionality of pyCA.

So, do we want this?

[JanKoppe]

Meeting with Lars via Appear.in: Yes, we should do that. Milestone 2.0

[lkiesow]

You should be able to use jsonify to easily solve this:

from flask import jsonify

@app.route('/api')
def summary():
    …
    return jsonify(data)

[lkiesow]

Maybe generate data in a separate method which we can use for home() as well to minimize code duplication.

[JanKoppe]

Yes, I'm building a /api/internal_state endpoint as well as /api/event, which will return the events. This would probably reduce the UI to a static file with some jQuery or similar to retrieve & update data.

Probably won't get this done in time, so this will go in with 2.1 probably.

[JanKoppe]

Work on this is happening in #73.

[lkiesow]

Fixed by #73