Those are usually linked through other OpenAPI specification documents and different examples can refer to the same specification. Fixed violations along the way, most of them were typos in either the schema or the example. In one case a wrong schema was referenced, most likely because the name was sufficiently confusing. The reference went to `query_filter_instance_schema_model`, when it should have been `query_filter_instance_model`. Sadly, the latter didn't even exist as a schema. I changed the reference and added a schema based on what I could find in our implemented representer. It was consistent with examples.
sidebar_navigation, description, keywords
| sidebar_navigation | description | keywords | ||||
|---|---|---|---|---|---|---|
|
Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud. | help, documentation |
OpenProject Documentation
Note
For enhanced usability, access the OpenProject documentation at www.openproject.org/docs/.
Installation
Get started with installing and upgrading OpenProject using our Installation Guide starting point.
The guides packaged and Docker-based installations are provided.
Upgrading
The detailed upgrade instructions for our packaged installer are located on the official website.
The guides for upgrading are provided.
Operation
- Backing up you installation
- Alter configuration of OpenProject
- Manual repository integration for Git and Subversion
- Configure incoming mails
- Install custom plugins
User Guides
Please see our User Guide pages for detailed documentation on the functionality of OpenProject.
Use Cases
Please see our Use Cases section for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.
Development
- Full development environment for developers
- Developing plugins
- Developing OmniAuth Plugins
- Running tests
- Code review guidelines
- API documentation
APIv3 documentation sources
The documentation for APIv3 is written in the OpenAPI Format and its sources are being built from the entry point openapi-spec.yml.