Apply suggestions from code review

Co-authored-by: tasso94 <[email protected]>
camunda · Sep 20, 2024 · e6dc437 · e6dc437
1 parent fa47e2e
commit e6dc437
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/engine-rest/engine-rest-openapi/src/main/templates/lib/commons/history-process-instance.ftl b/engine-rest/engine-rest-openapi/src/main/templates/lib/commons/history-process-instance.ftl
@@ -240,7 +240,7 @@
   "activityIdIn": {
     "type": "array",
     "itemType": "string",
-    "desc": "Restrict to instances that have an active activity or failing activity with one of the given ids. ${listTypeDescription}"
+    "desc": "Restrict to instances with an active activity with one of the given ids. This filter behaves differently as `activeActivityIdIn` since it also yields results when filtering for activities with an incident. ${listTypeDescription}"
   },
 
   "executedActivityIdIn": {

diff --git a/engine/src/main/java/org/camunda/bpm/engine/history/HistoricProcessInstanceQuery.java b/engine/src/main/java/org/camunda/bpm/engine/history/HistoricProcessInstanceQuery.java
@@ -441,7 +441,7 @@ public interface HistoricProcessInstanceQuery extends Query<HistoricProcessInsta
   HistoricProcessInstanceQuery activeActivityIdIn(String... ids);
 
   /**
-   * Only select historic process instances that have active activities or failing activities with given ids.
+   * Only select historic process instances with an active activity with one of the given ids. This filter behaves differently as `activeActivityIdIn` since it also yields results when filtering for activities with an incident.
    */
   HistoricProcessInstanceQuery activityIdIn(String... ids);