OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/docs/api
Oliver Günther e9cc09840d
Add hidden flag for project-context queries
6 years ago
..
api_documentation_layouts Rename doc to docs and restructure operations folder 8 years ago
apiv3 Add hidden flag for project-context queries 6 years ago
README.md Rename doc to docs and restructure operations folder 8 years ago
apiv3-doc-dev.apib Split APIv3 documentation into stable/dev versions 6 years ago
apiv3-doc-stable.apib Split APIv3 documentation into stable/dev versions 6 years ago

README.md

API Documentation

API Version 3

Status: under development

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

The generated APIv3 documentation is built regular on the dev branch and can be found at: opf.github.io/apiv3-doc/.

You can also use aglio to generate HTML documentation locally, e.g. using the following command:

aglio -i apiv3-documentation.apib -o api.html