Document + Design REST api

Description

We currently do provide a REST api exposed by the server but we don't have any proper documentation approach for showing the users what is available and how to use it. Many tools are currently in the making to fill this gap. One of these tools is http://swagger.io/ (see an example located at: http://editor.swagger.io/#/

With this, we could document everything properly. The next step in the future could be to generate the server side (but I don't see this in the near future, something little bit further away).

Another tool is https://apiary.io/ which does look good, too (at least from a design point of view).

Could be hosted on Jenkins

Environment

None

Assignee

Mario Mann

Reporter

Patrice Bouillet

Labels

None

Integrator

None

Sprint

None

Fix versions

Priority

Low
Configure