Skip to content

Commit 6bb1cdb

Browse files
oliverguentheroliverguenther
committed
Split APIv3 documentation into stable/dev versions
[ci skip]
1 parent e3eadf8 commit 6bb1cdb

6 files changed

Lines changed: 50 additions & 40 deletions

File tree

‎docs/api/apiv3-doc-dev.apib‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
FORMAT: 1A
2+
3+
# OpenProject API V3 (DEV)
4+
5+
You're looking at the current **development** documentation of the OpenProject APIv3. If you're interested in the current
6+
stable version, please go to https://docs.openproject.org/apiv3-doc/
7+
8+
<!-- include(apiv3/index.apib) -->

‎docs/api/apiv3-doc-stable.apib‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
FORMAT: 1A
2+
3+
# OpenProject API V3 (Stable)
4+
5+
You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current
6+
development version, please go to https://docs.openproject.org/apiv3-doc-dev/
7+
8+
<!-- include(apiv3/index.apib) -->

‎docs/api/apiv3-documentation.apib‎

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/api/apiv3/endpoints/queries.apib‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ If the values are nonprimitive (e.g. User, Project), they will be listed as obje
105105
106106
```
107107

108-
## Query [/api/v3/queries/{id}{?offset,pageSize,filters,sortBy,groupBy,showSums,timelineVisible,timelineLabels,timelineZoomLevel,highlightingMode,highlightedAttributes,showHierarchies}]
108+
## Query [/api/v3/queries/{id}{?offset,pageSize,filters,columns,sortBy,groupBy,showSums,timelineVisible,timelineLabels,timelineZoomLevel,highlightingMode,highlightedAttributes,showHierarchies}]
109109

110110
+ Model
111111
+ Body

‎docs/api/apiv3/index.apib‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!-- include(introduction.apib) -->
2+
<!-- include(basic-objects.apib) -->
3+
<!-- include(group-objects.apib) -->
4+
5+
<!-- include(endpoints/activities.apib) -->
6+
<!-- include(endpoints/attachments.apib) -->
7+
<!-- include(endpoints/categories.apib) -->
8+
<!-- include(endpoints/configuration.apib) -->
9+
<!-- include(endpoints/custom-actions.apib) -->
10+
<!-- include(endpoints/custom-options.apib) -->
11+
<!-- include(endpoints/forms.apib) -->
12+
<!-- include(endpoints/groups.apib) -->
13+
<!-- include(endpoints/help_texts.apib) -->
14+
<!-- include(endpoints/posts.apib) -->
15+
<!-- include(endpoints/principals.apib) -->
16+
<!-- include(endpoints/priorities.apib) -->
17+
<!-- include(endpoints/projects.apib) -->
18+
<!-- include(endpoints/queries.apib) -->
19+
<!-- include(endpoints/relations.apib) -->
20+
<!-- include(endpoints/render.apib) -->
21+
<!-- include(endpoints/revisions.apib) -->
22+
<!-- include(endpoints/roles.apib) -->
23+
<!-- include(endpoints/root.apib) -->
24+
<!-- include(endpoints/schemas.apib) -->
25+
<!-- include(endpoints/statuses.apib) -->
26+
<!-- include(endpoints/string-objects.apib) -->
27+
<!-- include(endpoints/time_entries.apib) -->
28+
<!-- include(endpoints/types.apib) -->
29+
<!-- include(endpoints/user-preferences.apib) -->
30+
<!-- include(endpoints/users.apib) -->
31+
<!-- include(endpoints/versions.apib) -->
32+
<!-- include(endpoints/wiki_pages.apib) -->
33+
<!-- include(endpoints/work-packages.apib) -->

‎docs/api/apiv3/introduction.apib‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11

22
# Group General
33

4-
This is the current **DRAFT** of the specification for OpenProject APIv3.
5-
64
Please note that everything in this document might be **subject to change** in a future version of OpenProject. We intend to keep this specification
75
as accurate as possible, however as long as the APIv3 is not in a stable state it is possible that there are intermediary differences between
86
this specification and the real implementation. While we try to only specify what we want to keep, it might also happen that parts of this

0 commit comments

Comments
 (0)