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.
30290 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: c319431bd1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c319431bd1'
${ noResults }
openproject/doc
History
Jens Ulferts 1a7d77e56b
Merge branch 'release/6.1' into dev 		8 years ago
..
api_documentation_layouts Insert new icon font and start updating the classes 9 years ago
apiv3 Merge remote-tracking branch 'origin/release/6.1' into dev 8 years ago
development Merge remote-tracking branch 'origin/release/6.1' into dev 8 years ago
operation_guides Merge pull request #5149 from opf/correct-os-requirements 8 years ago
CONFIGURATION.md Minor typos discovered while installing development version. 8 years ago
COPYING.rdoc Adds a copy of the GPL Version 3. 12 years ago
COPYRIGHT.rdoc Update copyright notice 8 years ago
COPYRIGHT_short.rdoc Update copyright notice 8 years ago
QUICK_START.md Bump node version for travis, packager and documentation 8 years ago
README.md Fix paths to other docs in developer README 10 years ago
RUNNING_TESTS.md Remove gulp with simpler npm tasks 9 years ago
RUNNING_TESTS_LDAP.rdoc recovery ldap test doc 10 years ago
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 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.