TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
57710 Commits
139 Branches
203 Tags
1.2 GiB
Tag: Branch: Tree: a25a5e2c20
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a25a5e2c20'
${ noResults }
openproject/docs/api/README.md

26 lines
1.3 KiB
Raw Normal View History Unescape

Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
# OpenProject API
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
OpenProject offers two APIs. The general purpose HATEOAS API v3 and the BCF API v2.1 api targeted towards BIM use cases.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
Please note that we intend to keep this specification as accurate and stable as possible, however work on the API is still ongoing
and not all resources and actions in OpenProject are yet accessible through the API.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
This document will be subject to changes as we add more endpoints and functionality to the API. The development version of this document
may have breaking changes while we work on new endpoints for the application.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
We try to keep stable releases of OpenProject with changes to this API backwards compatible whenever possible.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
## API v3
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
The API v3 is a general purpose API supporting multiple use cases.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Feature/api example (#8699) * fix structure of api v3 documentation * provide examples for api v3 usage
4 years ago
While by no means complete, a whole lot of different scenarios can be automatised which otherwise would have to be caried out by hand via the UI.
Examples for this include managing work packages, projects and users.
## BCF v2.1
This API supports BCF management in the context of BIM projects.
While this API supports way less use cases than the more generic *API v3* it is compatible with the generic specification of a BCF API as [defined by the standard](https://github.com/buildingSMART/BCF-API/blob/release_2_1/README.md). This, clients implementing the specification can manage topics and viewpoints.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago