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.
63498 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 832f8b596b
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '832f8b596b'
${ noResults }
openproject/docs/api/apiv3
History
Markus Kahl 0623f153e7
make basic auth docs less ambiguous 		3 years ago
..
client-libraries Fix/docs (#9442) 3 years ago
components improve api documentation about versions and wp schemas 3 years ago
example Docs cherry picks from release-12.0 (#10527) 3 years ago
paths Add typeahead sort option 3 years ago
tags improve api documentation about versions and wp schemas 3 years ago
README.md [#40397] OpenAPI Specs not OpenAPI 3.0 compatible 3 years ago
openapi-spec.yml make basic auth docs less ambiguous 3 years ago

README.md

API Version 3

Status: under development

The documentation for APIv3 is written according to the OpenAPI 3.0 Specification.

The file in the repository is split up into many files. Some OAS (OpenAPI Specification) do not support that. You can retrieve the complete, singular file from any OpenProject server under /api/v3/spec.json or /api/v3/spec.yml. Additionally, there is a script that outputs the specification as a whole as well, either as json or yaml depending on the given format argument:

./script/api/spec --format yaml > openproject-oas.yml