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
Markus Kahl a781501dc0 Merge pull request #4182 from oliverguenther/feature/configuration-structures 9 years ago
..
api_documentation_layouts Insert new icon font and start updating the classes 9 years ago
development Remove summary attribute and all traces of it from Project 9 years ago
operation_guides Merge branch 'release/5.0' into dev 9 years ago
CONFIGURATION.md Add simple YAML extraction of ENV overrides 9 years ago
COPYING.rdoc Adds a copy of the GPL Version 3. 12 years ago
COPYRIGHT.rdoc Update year in copyright header to 2015 10 years ago
COPYRIGHT_short.rdoc Update year in copyright header to 2015 10 years ago
QUICK_START.md Add link to detailed guide 9 years ago
README.md Fix paths to other docs in developer README 10 years ago
RUNNING_TESTS.md Add documentation about using parallel testing tasks 9 years ago
RUNNING_TESTS_LDAP.rdoc recovery ldap test doc 10 years ago
UPGRADING.rdoc Update OpenProject URLs 10 years ago
apiv2-documentation.md Allow the configuration to disable APIv2 basic auth 9 years ago
apiv3-documentation.apib document compression 9 years ago
code-review-guidelines.md Adds code review guidelines 9 years ago
subversion_and_git_integration.md Improve and extend repository documentation 9 years ago

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.