Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Clarify APIv3 docs

Jan Sandbrinke83f19711193
diff --git a/docs/api/apiv3/tags/categories.yml b/docs/api/apiv3/tags/categories.yml
index c9a69e79e18..06cdf96e949 100644
--- a/docs/api/apiv3/tags/categories.yml
+++ b/docs/api/apiv3/tags/categories.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The categories endpoints return collections or single entities of type `Category`. The following tables list the different properties
+ of `Category` entities.
+
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
diff --git a/docs/api/apiv3/tags/custom_options.yml b/docs/api/apiv3/tags/custom_options.yml
index 142fc19a167..6e32e532c4b 100644
--- a/docs/api/apiv3/tags/custom_options.yml
+++ b/docs/api/apiv3/tags/custom_options.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The custom options endpoints return collections or single entities of type `CustomOption`. The following tables list the different properties
+ of `CustomOption` entities.
+
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
diff --git a/docs/api/apiv3/tags/help_texts.yml b/docs/api/apiv3/tags/help_texts.yml
index 2a6592a372e..1466908eec1 100644
--- a/docs/api/apiv3/tags/help_texts.yml
+++ b/docs/api/apiv3/tags/help_texts.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The help texts endpoints return collections or single entities of type `HelpText`. The following tables list the different properties
+ of `HelpText` entities.
+
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
diff --git a/docs/api/apiv3/tags/priorities.yml b/docs/api/apiv3/tags/priorities.yml
index 7004adda68f..ac040765a60 100644
--- a/docs/api/apiv3/tags/priorities.yml
+++ b/docs/api/apiv3/tags/priorities.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The priorities endpoints return collections or single entities of type `Priority`. The following tables list the different properties
+ of `Priority` entities.
+
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
diff --git a/docs/api/apiv3/tags/statuses.yml b/docs/api/apiv3/tags/statuses.yml
index a8623c757a1..d9e3e9c8a3a 100644
--- a/docs/api/apiv3/tags/statuses.yml
+++ b/docs/api/apiv3/tags/statuses.yml
@@ -1,5 +1,8 @@
name: Statuses
description: |-
+ The statuses endpoints return collections or single entities of type `Status`. The following tables list the different properties
+ of `Status` entities.
+
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
diff --git a/docs/api/apiv3/tags/time_entries.yml b/docs/api/apiv3/tags/time_entries.yml
index c25ee086b7e..9c56a9e172e 100644
--- a/docs/api/apiv3/tags/time_entries.yml
+++ b/docs/api/apiv3/tags/time_entries.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The time entries endpoints return collections or single entities of type `TimeEntry`. The following tables list the different properties
+ of `TimeEntry` entities.
+
## Actions
| Link | Description | Condition |
diff --git a/docs/api/apiv3/tags/userpreferences.yml b/docs/api/apiv3/tags/userpreferences.yml
index 54e93e3f9e4..67c78ace27f 100644
--- a/docs/api/apiv3/tags/userpreferences.yml
+++ b/docs/api/apiv3/tags/userpreferences.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The user preferences endpoints return collections or single entities of type `UserPreferences`. The following tables list the different properties
+ of `UserPreferences` entities.
+
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
diff --git a/docs/api/apiv3/tags/users.yml b/docs/api/apiv3/tags/users.yml
index f047b64d03c..1d4f2bc2293 100644
--- a/docs/api/apiv3/tags/users.yml
+++ b/docs/api/apiv3/tags/users.yml
@@ -1,6 +1,9 @@
---
name: Users
description: |-
+ The users endpoints return collections or single entities of type `User`. The following tables list the different properties
+ of `User` entities.
+
## Actions
| Link | Description | Condition |
diff --git a/docs/api/apiv3/tags/work_packages.yml b/docs/api/apiv3/tags/work_packages.yml
index 809490e9625..0b999fded32 100644
--- a/docs/api/apiv3/tags/work_packages.yml
+++ b/docs/api/apiv3/tags/work_packages.yml
@@ -1,5 +1,8 @@
---
description: |-
+ The work packages endpoints return collections or single entities of type `WorkPackage`. The following tables list the different properties
+ of `WorkPackage` entities.
+
## Actions
| Link | Description | Condition |