Files
openproject/docs/api/apiv3
Eric Schubert abbaf045c5 [chore] fix api spec validation
- validation script used unmaintained npm package
- switched to actively maintained package from same maintainer
- pipe full output to stdout
- bump node major version in development backend Dockerfile
- fix two api spec errors and two random warnings - boyscout, hell yeah
2026-02-11 14:11:20 +01:00
..
2024-04-29 17:13:24 +02:00
2026-02-11 14:11:20 +01:00
2026-01-14 13:37:30 +01:00

API Version 3

Status: under development

The specification for the APIv3 is written according to the OpenAPI 3.1 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