TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
28875 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 6eef803292
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6eef803292'
${ noResults }
openproject/doc
History
Oliver Günther 80e0df1d56
Extend Upgrade guide with note to reconfigure 		8 years ago
..
api_documentation_layouts
…
development Update documentation 8 years ago
operation_guides Extend Upgrade guide with note to reconfigure 8 years ago
CONFIGURATION.md [22987] [Onboarding] Getting started video screen (2) (#4464) 9 years ago
COPYING.rdoc
…
COPYRIGHT.rdoc
…
COPYRIGHT_short.rdoc
…
QUICK_START.md Add information for default admin user to quick start (#4347) 9 years ago
README.md
…
RUNNING_TESTS.md Remove gulp with simpler npm tasks 9 years ago
RUNNING_TESTS_LDAP.rdoc
…
UPGRADING.rdoc
…
apiv2-documentation.md Allow the configuration to disable APIv2 basic auth 9 years ago
apiv3-documentation.apib Add separate preview link for comments without form 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.