generate API documentation

[carueda]

That is, automatically from the code.

Currently, this is generated pseudo-manually by editing a file with http://editor.swagger.io/, and using the swagger.yaml as a basis for actual documentation sites using swagger-ui. Those sites are linked from http://mmisw.org/orrdoc/api/

Although the manual editing of the specification is OK in general (in fact, actually very flexible), this task is about eventually automating the generation of the specification from code. Although there are mechanisms for this, the currently used relevant scalatra libraries would first have to be updated for this automatic generation; unfortunately such upgrades are not trivial at all (previous attempts to do so proved to be very tricky in terms of other dependent libraries that haven't been updated to more recent versions of underlying scalatra libraries.)

Consider this a low-priority task for the time being.

[carueda]

The use of the external editing of the api documentation has in fact proved to good enough. Decided to close this one.