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
Eric Schubert e74134c857
[#40228] improved spec examples
3 years ago
..
client-libraries Fix/docs (#9442) 3 years ago
components [#40228] improved spec examples 3 years ago
example Task/40080 reduce excessive image file sizes in docs [skip ci] (#9887) 3 years ago
paths [#40228] added storage_id filter to wp collection 3 years ago
tags Fix various typos 3 years ago
README.md [#40397] OpenAPI Specs not OpenAPI 3.0 compatible 3 years ago
openapi-spec.yml [#40228] introduced collection model for file links 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