Update API docs: add Job Suspension operation & also add all the missing Archive and Systems API endpoints

[jsyrjala]

Wiki talks about PATCH call to /systems/:system/jobs/:jobid in https://github.com/mikub/titanoboa/wiki/Designing-Workflows#suspendable but API docs do not mention them (https://github.com/mikub/titanoboa/wiki/API-Documentation)

[jsyrjala]

Also is there a Swagger/OpenAPI description available?

[mikub]

Hi @jsyrjala ,
yep the API documentation needs some updating, apart the recent addition pf suspending/resuming jobs there is also a need to add API docs for systems operations (starting/stopping system & workers etc.).
I should be able to do that soon.
In the meantime handler.clj https://github.com/mikub/titanoboa/blob/master/src/clj/titanoboa/handler.clj could be used as the source of truth (which of course is not ideal).

I am not a big fan of swagger but defo it is worth considering or looking at some alternatives.

Cheers
Miro

[mikub]

I added first note regarding suspension: https://github.com/mikub/titanoboa/wiki/API-Documentation#suspend-a-running-workflow-job
Will also add API docs for systems and also archive.

[mikub]

Added https://github.com/mikub/titanoboa/wiki/API-Documentation#systems-api and https://github.com/mikub/titanoboa/wiki/API-Documentation#authentication