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
ulferts 1e9f40587b Merge pull request #2405 from oliverguenther/feature/apiv3-user-lockunlock 10 years ago
..
operation_guides Removal of sqlite3 related packages 10 years ago
CONFIGURATION.md attachments backend migration doc 10 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
DEVELOP_PLUGINS.md Update year in copyright header to 2015 10 years ago
INSTALL.md Update year in copyright header to 2015 10 years ago
README.md add a README-file for the doc subdirectory 10 years ago
RUNNING_TESTS.md Update year in copyright header to 2015 10 years ago
UPGRADING.rdoc Update year in copyright header to 2015 10 years ago
apiv3-documentation.apib apiv3: User (Un-)Locking functionality 10 years ago
subversion_and_git_integration.md Document svn integration in doc/ directory 10 years ago

README.md

Documentation

About the APIv3 Documentation

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 apiary.apib -o api.html