references/openproject

mirror of https://github.com/opf/openproject.git synced 2026-06-14 03:30:14 +00:00

Files

T

History

Eric Schubert 887ded5714 [#71358 ] fixed version read model usage

- improved description of API spec

2026-02-12 13:13:11 +01:00

..

client-libraries

lint fix

2024-04-29 17:13:24 +02:00

[#71358 ] fixed version read model usage

2026-02-12 13:13:11 +01:00

create 8bit PNGs, reduce color palettes, max width 2000 px

2025-10-23 11:52:29 +02:00

[#71358 ] improve API specification for versions

2026-02-11 16:35:03 +01:00

fix links

2026-01-14 13:37:30 +01:00

openapi-spec.yml

[#71358 ] improve API specification for versions

2026-02-11 16:35:03 +01:00

README.md

fix markdown quirks; harmonize; lint fixes

2024-04-29 13:52:04 +02:00

README.md

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