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 f3e86b9e93
Merge pull request #11966 from opf/implementation/45908-api-specification-add-prepare-upload-endpoint
2 years ago
..
client-libraries Update README.md (#11096) [skip ci] 2 years ago
components Merge pull request #11966 from opf/implementation/45908-api-specification-add-prepare-upload-endpoint 2 years ago
example Fix some spacing issues in documentation 2 years ago
paths Merge pull request #11966 from opf/implementation/45908-api-specification-add-prepare-upload-endpoint 2 years ago
tags Merge branch 'release/12.4' into dev 2 years ago
README.md [#40397] OpenAPI Specs not OpenAPI 3.0 compatible 3 years ago
openapi-spec.yml Merge pull request #11966 from opf/implementation/45908-api-specification-add-prepare-upload-endpoint 2 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