Status: under development

The documentation for APIv3 is written in the API Blueprint Format.

You can use aglio to generate HTML documentation. Aglio supports the use of templates to adjust the ouput to your own needs. OpenProject is using the openproject.jade template file. To generate the documentation using the openproject.jade layout file the following command:

aglio -t openproject-layout.jade -i ../apiv3-documentation.api -o api.html