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/docs/api/apiv3
ulferts 1b89d753fc remove documentation for work_package relations form 3 years ago
..
client-libraries Fix/docs (#9442) 3 years ago
components/schemas Fix apiv3 notifications model 3 years ago
example Fix/docs (#9442) 3 years ago
paths remove documentation for work_package relations form 3 years ago
tags remove no_self_notified user preference 3 years ago
README.md Fix/docs (#9442) 3 years ago
openapi-spec.yml remove documentation for work_package relations form 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 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