diff --git a/docs/api/apiv3-doc-dev.apib b/docs/api/apiv3-doc-dev.apib new file mode 100644 index 0000000000..438742669e --- /dev/null +++ b/docs/api/apiv3-doc-dev.apib @@ -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/ + + diff --git a/docs/api/apiv3-doc-stable.apib b/docs/api/apiv3-doc-stable.apib new file mode 100644 index 0000000000..4381c7ff98 --- /dev/null +++ b/docs/api/apiv3-doc-stable.apib @@ -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/ + + diff --git a/docs/api/apiv3-documentation.apib b/docs/api/apiv3-documentation.apib deleted file mode 100644 index dd528589c7..0000000000 --- a/docs/api/apiv3-documentation.apib +++ /dev/null @@ -1,37 +0,0 @@ -FORMAT: 1A - -# OpenProject API v3 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api/apiv3/endpoints/queries.apib b/docs/api/apiv3/endpoints/queries.apib index 8978dcb5fb..a2cf245667 100644 --- a/docs/api/apiv3/endpoints/queries.apib +++ b/docs/api/apiv3/endpoints/queries.apib @@ -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 diff --git a/docs/api/apiv3/index.apib b/docs/api/apiv3/index.apib new file mode 100644 index 0000000000..16c2fd41f4 --- /dev/null +++ b/docs/api/apiv3/index.apib @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/api/apiv3/introduction.apib b/docs/api/apiv3/introduction.apib index 5b848094a2..bce6b4445e 100644 --- a/docs/api/apiv3/introduction.apib +++ b/docs/api/apiv3/introduction.apib @@ -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