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.
59335 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 570e5de984
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '570e5de984'
${ noResults }
openproject/docs/api/apiv3
History
Markus Kahl c958d57beb
merged view_user_model into user_model 		3 years ago
..
client-libraries Update README.md (#9099) 4 years ago
components/schemas merged view_user_model into user_model 3 years ago
example Fix typos in user facing and non-user facing code 4 years ago
paths merged view_user_model into user_model 3 years ago
tags openapi spec, post apib conversion 3 years ago
README.md openapi spec, post apib conversion 3 years ago
openapi-spec.yml merged view_user_model into user_model 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 generated APIv3 documentation is built regular on the dev branch and can be found at: opf.github.io/apiv3-doc/.

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 under /api/v3/spec.json or /api/v3/spec.yml. Additionally there is a rake task that outputs the specification as a whole as well, either as json or yaml depending on the given output file name:

bundle exec rake api:save_spec ./openproject-oas.yml