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 816057e65e allow suppressing notifications on member create/update 3 years ago
..
client-libraries Fix/docs (#9442) 3 years ago
components/schemas fix(openapi-spec): adjust invalid yml (#9809) 3 years ago
example Task/40080 reduce excessive image file sizes in docs [skip ci] (#9887) 3 years ago
paths allow suppressing notifications on member create/update 3 years ago
tags feat(docs): changes & cleanup [skip ci] (#9941) 3 years ago
README.md Fix/docs (#9442) 3 years ago
openapi-spec.yml explain openapi spec details in introduction 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