TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Split APIv3 documentation into stable/dev versions

Browse Source 
[ci skip]
pull/6848/head
Oliver Günther 6 years ago
parent e3eadf8b07
commit 6bb1cdba88
No known key found for this signature in database
GPG Key ID: A3A8BDAD7C0C552C
6 changed files with 50 additions and 40 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 8
      docs/api/apiv3-doc-dev.apib
  2. 8
      docs/api/apiv3-doc-stable.apib
  3. 37
      docs/api/apiv3-documentation.apib
  4. 2
      docs/api/apiv3/endpoints/queries.apib
  5. 33
      docs/api/apiv3/index.apib
  6. 2
      docs/api/apiv3/introduction.apib

8
docs/api/apiv3-doc-dev.apib
Unescape View File

@ -0,0 +1,8 @@
FORMAT: 1A
# OpenProject API V3 (DEV)
You're looking at the current **development** documentation of the OpenProject APIv3. If you're interested in the current
stable version, please go to https://docs.openproject.org/apiv3-doc/
<!-- include(apiv3/index.apib) -->

8
docs/api/apiv3-doc-stable.apib
Unescape View File

@ -0,0 +1,8 @@
FORMAT: 1A
# OpenProject API V3 (Stable)
You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current
development version, please go to https://docs.openproject.org/apiv3-doc-dev/
<!-- include(apiv3/index.apib) -->

37
docs/api/apiv3-documentation.apib
Unescape View File

@ -1,37 +0,0 @@
FORMAT: 1A
# OpenProject API v3
<!-- include(apiv3/introduction.apib) -->
<!-- include(apiv3/basic-objects.apib) -->
<!-- include(apiv3/group-objects.apib) -->
<!-- include(apiv3/endpoints/activities.apib) -->
<!-- include(apiv3/endpoints/attachments.apib) -->
<!-- include(apiv3/endpoints/categories.apib) -->
<!-- include(apiv3/endpoints/configuration.apib) -->
<!-- include(apiv3/endpoints/custom-actions.apib) -->
<!-- include(apiv3/endpoints/custom-options.apib) -->
<!-- include(apiv3/endpoints/forms.apib) -->
<!-- include(apiv3/endpoints/groups.apib) -->
<!-- include(apiv3/endpoints/help_texts.apib) -->
<!-- include(apiv3/endpoints/posts.apib) -->
<!-- include(apiv3/endpoints/principals.apib) -->
<!-- include(apiv3/endpoints/priorities.apib) -->
<!-- include(apiv3/endpoints/projects.apib) -->
<!-- include(apiv3/endpoints/queries.apib) -->
<!-- include(apiv3/endpoints/relations.apib) -->
<!-- include(apiv3/endpoints/render.apib) -->
<!-- include(apiv3/endpoints/revisions.apib) -->
<!-- include(apiv3/endpoints/roles.apib) -->
<!-- include(apiv3/endpoints/root.apib) -->
<!-- include(apiv3/endpoints/schemas.apib) -->
<!-- include(apiv3/endpoints/statuses.apib) -->
<!-- include(apiv3/endpoints/string-objects.apib) -->
<!-- include(apiv3/endpoints/time_entries.apib) -->
<!-- include(apiv3/endpoints/types.apib) -->
<!-- include(apiv3/endpoints/user-preferences.apib) -->
<!-- include(apiv3/endpoints/users.apib) -->
<!-- include(apiv3/endpoints/versions.apib) -->
<!-- include(apiv3/endpoints/wiki_pages.apib) -->
<!-- include(apiv3/endpoints/work-packages.apib) -->

2
docs/api/apiv3/endpoints/queries.apib
Unescape View File

@ -105,7 +105,7 @@ If the values are nonprimitive (e.g. User, Project), they will be listed as obje
```
## Query [/api/v3/queries/{id}{?offset,pageSize,filters,sortBy,groupBy,showSums,timelineVisible,timelineLabels,timelineZoomLevel,highlightingMode,highlightedAttributes,showHierarchies}]
## Query [/api/v3/queries/{id}{?offset,pageSize,filters,columns,sortBy,groupBy,showSums,timelineVisible,timelineLabels,timelineZoomLevel,highlightingMode,highlightedAttributes,showHierarchies}]
+ Model
+ Body

33
docs/api/apiv3/index.apib
Unescape View File

@ -0,0 +1,33 @@
<!-- include(introduction.apib) -->
<!-- include(basic-objects.apib) -->
<!-- include(group-objects.apib) -->
<!-- include(endpoints/activities.apib) -->
<!-- include(endpoints/attachments.apib) -->
<!-- include(endpoints/categories.apib) -->
<!-- include(endpoints/configuration.apib) -->
<!-- include(endpoints/custom-actions.apib) -->
<!-- include(endpoints/custom-options.apib) -->
<!-- include(endpoints/forms.apib) -->
<!-- include(endpoints/groups.apib) -->
<!-- include(endpoints/help_texts.apib) -->
<!-- include(endpoints/posts.apib) -->
<!-- include(endpoints/principals.apib) -->
<!-- include(endpoints/priorities.apib) -->
<!-- include(endpoints/projects.apib) -->
<!-- include(endpoints/queries.apib) -->
<!-- include(endpoints/relations.apib) -->
<!-- include(endpoints/render.apib) -->
<!-- include(endpoints/revisions.apib) -->
<!-- include(endpoints/roles.apib) -->
<!-- include(endpoints/root.apib) -->
<!-- include(endpoints/schemas.apib) -->
<!-- include(endpoints/statuses.apib) -->
<!-- include(endpoints/string-objects.apib) -->
<!-- include(endpoints/time_entries.apib) -->
<!-- include(endpoints/types.apib) -->
<!-- include(endpoints/user-preferences.apib) -->
<!-- include(endpoints/users.apib) -->
<!-- include(endpoints/versions.apib) -->
<!-- include(endpoints/wiki_pages.apib) -->
<!-- include(endpoints/work-packages.apib) -->

2
docs/api/apiv3/introduction.apib
Unescape View File

@ -1,8 +1,6 @@
# Group General
This is the current **DRAFT** of the specification for OpenProject APIv3.
Please note that everything in this document might be **subject to change** in a future version of OpenProject. We intend to keep this specification
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
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

Write Preview
Loading…
Cancel
Save