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/doc
Oliver Günther 5e22b1e9ef Add fog environment variables 8 years ago
..
api_documentation_layouts
apiv3 Add ancestors information through separate grouped SQL 8 years ago
development Remove bower and move dependencies to node 8 years ago
operation_guides Update supported ruby versions 8 years ago
CONFIGURATION.md Add fog environment variables 8 years ago
COPYING.rdoc
COPYRIGHT.rdoc Update copyright notice 8 years ago
COPYRIGHT_short.rdoc Update copyright notice 8 years ago
QUICK_START.md Remove bower and move dependencies to node 8 years ago
README.md
RUNNING_TESTS.md Remove gulp with simpler npm tasks 9 years ago
RUNNING_TESTS_LDAP.rdoc
UPGRADING.rdoc Update copyright notice 8 years ago
apiv2-documentation.md Allow the configuration to disable APIv2 basic auth 9 years ago
apiv3-documentation.apib Extract APIV3 documentation into single endpoints 8 years ago
code-review-guidelines.md
subversion_and_git_integration.md

README.md

OpenProject Developer Documentation

API Documentation

API Version 3

Status: under development

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

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

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

API Version 2

Status: deprecated

Documentation may be found on our API v2 wiki pages.