From 92151040a5d52966e2f2b5bf09384e93814ea877 Mon Sep 17 00:00:00 2001 From: Manuel Jell Date: Mon, 9 Nov 2026 09:11:10 +0100 Subject: [PATCH] TJI-84 Add task query filtering to task API --- sdk/dotnet/Timr.Api/Endpoints/TaskApi.cs | 8 ++++---- .../src/main/java/com/timr/api/apis/TaskApi.java | 8 ++++---- .../src/main/java/com/timr/api/apis/TaskApi.java | 4 ++-- .../src/main/kotlin/com/timr/api/apis/TaskApi.kt | 6 +++--- sdk/python/timr_api/api/task_api.py | 12 ++++++------ sdk/python/timr_api/configuration.py | 2 +- sdk/swift/TimrApi/APIs/TaskAPI.swift | 4 ++-- sdk/typescript-fetch/src/apis/TaskApi.ts | 2 +- spec/openapi.yaml | 4 ++-- 9 files changed, 25 insertions(+), 25 deletions(-) diff --git a/sdk/dotnet/Timr.Api/Endpoints/TaskApi.cs b/sdk/dotnet/Timr.Api/Endpoints/TaskApi.cs index c277d21..b58353a 100644 --- a/sdk/dotnet/Timr.Api/Endpoints/TaskApi.cs +++ b/sdk/dotnet/Timr.Api/Endpoints/TaskApi.cs @@ -93,7 +93,7 @@ public interface ITaskApi : IApi /// Thrown when fails to make API call /// Only return Tasks whose parent is the Task with this ID. (optional) /// Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - /// Only return Users whose name contains this text. (optional) + /// Only return Tasks whose breadcrumb path contains all words in this query. (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return Tasks that are active on this day. (optional) @@ -113,7 +113,7 @@ public interface ITaskApi : IApi /// /// Only return Tasks whose parent is the Task with this ID. (optional) /// Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - /// Only return Users whose name contains this text. (optional) + /// Only return Tasks whose breadcrumb path contains all words in this query. (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return Tasks that are active on this day. (optional) @@ -1519,7 +1519,7 @@ private void OnErrorFetchTasksDefaultImplementation(Exception exceptionLocalVar, /// /// Only return Tasks whose parent is the Task with this ID. (optional) /// Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - /// Only return Users whose name contains this text. (optional) + /// Only return Tasks whose breadcrumb path contains all words in this query. (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return Tasks that are active on this day. (optional) @@ -1547,7 +1547,7 @@ private void OnErrorFetchTasksDefaultImplementation(Exception exceptionLocalVar, /// Thrown when fails to make API call /// Only return Tasks whose parent is the Task with this ID. (optional) /// Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - /// Only return Users whose name contains this text. (optional) + /// Only return Tasks whose breadcrumb path contains all words in this query. (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return entries that are billable (true) or not billable (false). (optional) /// Only return Tasks that are active on this day. (optional) diff --git a/sdk/java-restclient/src/main/java/com/timr/api/apis/TaskApi.java b/sdk/java-restclient/src/main/java/com/timr/api/apis/TaskApi.java index 10dff38..7150932 100644 --- a/sdk/java-restclient/src/main/java/com/timr/api/apis/TaskApi.java +++ b/sdk/java-restclient/src/main/java/com/timr/api/apis/TaskApi.java @@ -236,7 +236,7 @@ public ResponseSpec deleteTaskWithResponseSpec(String id) throws RestClientRespo *

400 - Bad Request * @param parentTaskId Only return Tasks whose parent is the Task with this ID. * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). - * @param name Only return Users whose name contains this text. + * @param name Only return Tasks whose breadcrumb path contains all words in this query. * @param bookable Only return entries that are billable (true) or not billable (false). * @param billable Only return entries that are billable (true) or not billable (false). * @param activeAt Only return Tasks that are active on this day. @@ -288,7 +288,7 @@ private ResponseSpec fetchTasksRequestCreation(@Nullable String parentTaskId, @N *

400 - Bad Request * @param parentTaskId Only return Tasks whose parent is the Task with this ID. * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). - * @param name Only return Users whose name contains this text. + * @param name Only return Tasks whose breadcrumb path contains all words in this query. * @param bookable Only return entries that are billable (true) or not billable (false). * @param billable Only return entries that are billable (true) or not billable (false). * @param activeAt Only return Tasks that are active on this day. @@ -311,7 +311,7 @@ public TasksPage fetchTasks(@Nullable String parentTaskId, @Nullable Boolean tra *

400 - Bad Request * @param parentTaskId Only return Tasks whose parent is the Task with this ID. * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). - * @param name Only return Users whose name contains this text. + * @param name Only return Tasks whose breadcrumb path contains all words in this query. * @param bookable Only return entries that are billable (true) or not billable (false). * @param billable Only return entries that are billable (true) or not billable (false). * @param activeAt Only return Tasks that are active on this day. @@ -334,7 +334,7 @@ public ResponseEntity fetchTasksWithHttpInfo(@Nullable String parentT *

400 - Bad Request * @param parentTaskId Only return Tasks whose parent is the Task with this ID. * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). - * @param name Only return Users whose name contains this text. + * @param name Only return Tasks whose breadcrumb path contains all words in this query. * @param bookable Only return entries that are billable (true) or not billable (false). * @param billable Only return entries that are billable (true) or not billable (false). * @param activeAt Only return Tasks that are active on this day. diff --git a/sdk/java-resttemplate/src/main/java/com/timr/api/apis/TaskApi.java b/sdk/java-resttemplate/src/main/java/com/timr/api/apis/TaskApi.java index 87d24fa..9f9eb00 100644 --- a/sdk/java-resttemplate/src/main/java/com/timr/api/apis/TaskApi.java +++ b/sdk/java-resttemplate/src/main/java/com/timr/api/apis/TaskApi.java @@ -165,7 +165,7 @@ public ResponseEntity deleteTaskWithHttpInfo(@jakarta.annotation.Nonnull S *

400 - Bad Request * @param parentTaskId Only return Tasks whose parent is the Task with this ID. (optional) * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - * @param name Only return Users whose name contains this text. (optional) + * @param name Only return Tasks whose breadcrumb path contains all words in this query. (optional) * @param bookable Only return entries that are billable (true) or not billable (false). (optional) * @param billable Only return entries that are billable (true) or not billable (false). (optional) * @param activeAt Only return Tasks that are active on this day. (optional) @@ -187,7 +187,7 @@ public TasksPage fetchTasks(@jakarta.annotation.Nullable String parentTaskId, @j *

400 - Bad Request * @param parentTaskId Only return Tasks whose parent is the Task with this ID. (optional) * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - * @param name Only return Users whose name contains this text. (optional) + * @param name Only return Tasks whose breadcrumb path contains all words in this query. (optional) * @param bookable Only return entries that are billable (true) or not billable (false). (optional) * @param billable Only return entries that are billable (true) or not billable (false). (optional) * @param activeAt Only return Tasks that are active on this day. (optional) diff --git a/sdk/kotlin-okhttp/src/main/kotlin/com/timr/api/apis/TaskApi.kt b/sdk/kotlin-okhttp/src/main/kotlin/com/timr/api/apis/TaskApi.kt index b8fea2c..d61bfec 100644 --- a/sdk/kotlin-okhttp/src/main/kotlin/com/timr/api/apis/TaskApi.kt +++ b/sdk/kotlin-okhttp/src/main/kotlin/com/timr/api/apis/TaskApi.kt @@ -213,7 +213,7 @@ open class TaskApi(basePath: kotlin.String = defaultBasePath, client: Call.Facto * Lists the Tasks the authenticated user or API token can access. * @param parentTaskId Only return Tasks whose parent is the Task with this ID. (optional) * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - * @param name Only return Users whose name contains this text. (optional) + * @param name Only return Tasks whose breadcrumb path contains all words in this query. (optional) * @param bookable Only return entries that are billable (true) or not billable (false). (optional) * @param billable Only return entries that are billable (true) or not billable (false). (optional) * @param activeAt Only return Tasks that are active on this day. (optional) @@ -254,7 +254,7 @@ open class TaskApi(basePath: kotlin.String = defaultBasePath, client: Call.Facto * Lists the Tasks the authenticated user or API token can access. * @param parentTaskId Only return Tasks whose parent is the Task with this ID. (optional) * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - * @param name Only return Users whose name contains this text. (optional) + * @param name Only return Tasks whose breadcrumb path contains all words in this query. (optional) * @param bookable Only return entries that are billable (true) or not billable (false). (optional) * @param billable Only return entries that are billable (true) or not billable (false). (optional) * @param activeAt Only return Tasks that are active on this day. (optional) @@ -281,7 +281,7 @@ open class TaskApi(basePath: kotlin.String = defaultBasePath, client: Call.Facto * * @param parentTaskId Only return Tasks whose parent is the Task with this ID. (optional) * @param traverseTaskTree Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - * @param name Only return Users whose name contains this text. (optional) + * @param name Only return Tasks whose breadcrumb path contains all words in this query. (optional) * @param bookable Only return entries that are billable (true) or not billable (false). (optional) * @param billable Only return entries that are billable (true) or not billable (false). (optional) * @param activeAt Only return Tasks that are active on this day. (optional) diff --git a/sdk/python/timr_api/api/task_api.py b/sdk/python/timr_api/api/task_api.py index a1d85fe..fba0302 100644 --- a/sdk/python/timr_api/api/task_api.py +++ b/sdk/python/timr_api/api/task_api.py @@ -606,7 +606,7 @@ def fetch_tasks( self, parent_task_id: Annotated[Optional[StrictStr], Field(description="Only return Tasks whose parent is the Task with this ID.")] = None, traverse_task_tree: Annotated[Optional[StrictBool], Field(description="Include Tasks from the whole subtree (true) or only direct children (false).")] = None, - name: Annotated[Optional[StrictStr], Field(description="Only return Users whose name contains this text.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Only return Tasks whose breadcrumb path contains all words in this query.")] = None, bookable: Annotated[Optional[StrictBool], Field(description="Only return entries that are billable (true) or not billable (false).")] = None, billable: Annotated[Optional[StrictBool], Field(description="Only return entries that are billable (true) or not billable (false).")] = None, active_at: Annotated[Optional[Any], Field(description="Only return Tasks that are active on this day.")] = None, @@ -635,7 +635,7 @@ def fetch_tasks( :type parent_task_id: str :param traverse_task_tree: Include Tasks from the whole subtree (true) or only direct children (false). :type traverse_task_tree: bool - :param name: Only return Users whose name contains this text. + :param name: Only return Tasks whose breadcrumb path contains all words in this query. :type name: str :param bookable: Only return entries that are billable (true) or not billable (false). :type bookable: bool @@ -710,7 +710,7 @@ def fetch_tasks_with_http_info( self, parent_task_id: Annotated[Optional[StrictStr], Field(description="Only return Tasks whose parent is the Task with this ID.")] = None, traverse_task_tree: Annotated[Optional[StrictBool], Field(description="Include Tasks from the whole subtree (true) or only direct children (false).")] = None, - name: Annotated[Optional[StrictStr], Field(description="Only return Users whose name contains this text.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Only return Tasks whose breadcrumb path contains all words in this query.")] = None, bookable: Annotated[Optional[StrictBool], Field(description="Only return entries that are billable (true) or not billable (false).")] = None, billable: Annotated[Optional[StrictBool], Field(description="Only return entries that are billable (true) or not billable (false).")] = None, active_at: Annotated[Optional[Any], Field(description="Only return Tasks that are active on this day.")] = None, @@ -739,7 +739,7 @@ def fetch_tasks_with_http_info( :type parent_task_id: str :param traverse_task_tree: Include Tasks from the whole subtree (true) or only direct children (false). :type traverse_task_tree: bool - :param name: Only return Users whose name contains this text. + :param name: Only return Tasks whose breadcrumb path contains all words in this query. :type name: str :param bookable: Only return entries that are billable (true) or not billable (false). :type bookable: bool @@ -814,7 +814,7 @@ def fetch_tasks_without_preload_content( self, parent_task_id: Annotated[Optional[StrictStr], Field(description="Only return Tasks whose parent is the Task with this ID.")] = None, traverse_task_tree: Annotated[Optional[StrictBool], Field(description="Include Tasks from the whole subtree (true) or only direct children (false).")] = None, - name: Annotated[Optional[StrictStr], Field(description="Only return Users whose name contains this text.")] = None, + name: Annotated[Optional[StrictStr], Field(description="Only return Tasks whose breadcrumb path contains all words in this query.")] = None, bookable: Annotated[Optional[StrictBool], Field(description="Only return entries that are billable (true) or not billable (false).")] = None, billable: Annotated[Optional[StrictBool], Field(description="Only return entries that are billable (true) or not billable (false).")] = None, active_at: Annotated[Optional[Any], Field(description="Only return Tasks that are active on this day.")] = None, @@ -843,7 +843,7 @@ def fetch_tasks_without_preload_content( :type parent_task_id: str :param traverse_task_tree: Include Tasks from the whole subtree (true) or only direct children (false). :type traverse_task_tree: bool - :param name: Only return Users whose name contains this text. + :param name: Only return Tasks whose breadcrumb path contains all words in this query. :type name: str :param bookable: Only return entries that are billable (true) or not billable (false). :type bookable: bool diff --git a/sdk/python/timr_api/configuration.py b/sdk/python/timr_api/configuration.py index 6fb97d3..cf4a4c4 100644 --- a/sdk/python/timr_api/configuration.py +++ b/sdk/python/timr_api/configuration.py @@ -569,7 +569,7 @@ def to_debug_report(self) -> str: return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.2.1\n"\ + "Version of the API: 1.2.2\n"\ "SDK Package Version: 2.1.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/sdk/swift/TimrApi/APIs/TaskAPI.swift b/sdk/swift/TimrApi/APIs/TaskAPI.swift index a75d91b..242f7ec 100644 --- a/sdk/swift/TimrApi/APIs/TaskAPI.swift +++ b/sdk/swift/TimrApi/APIs/TaskAPI.swift @@ -104,7 +104,7 @@ open class TaskAPI { - parameter parentTaskId: (query) Only return Tasks whose parent is the Task with this ID. (optional) - parameter traverseTaskTree: (query) Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - - parameter name: (query) Only return Users whose name contains this text. (optional) + - parameter name: (query) Only return Tasks whose breadcrumb path contains all words in this query. (optional) - parameter bookable: (query) Only return entries that are billable (true) or not billable (false). (optional) - parameter billable: (query) Only return entries that are billable (true) or not billable (false). (optional) - parameter activeAt: (query) Only return Tasks that are active on this day. (optional) @@ -132,7 +132,7 @@ open class TaskAPI { - responseHeaders: [Link(String)] - parameter parentTaskId: (query) Only return Tasks whose parent is the Task with this ID. (optional) - parameter traverseTaskTree: (query) Include Tasks from the whole subtree (true) or only direct children (false). (optional, default to true) - - parameter name: (query) Only return Users whose name contains this text. (optional) + - parameter name: (query) Only return Tasks whose breadcrumb path contains all words in this query. (optional) - parameter bookable: (query) Only return entries that are billable (true) or not billable (false). (optional) - parameter billable: (query) Only return entries that are billable (true) or not billable (false). (optional) - parameter activeAt: (query) Only return Tasks that are active on this day. (optional) diff --git a/sdk/typescript-fetch/src/apis/TaskApi.ts b/sdk/typescript-fetch/src/apis/TaskApi.ts index cc26397..60b3945 100644 --- a/sdk/typescript-fetch/src/apis/TaskApi.ts +++ b/sdk/typescript-fetch/src/apis/TaskApi.ts @@ -76,7 +76,7 @@ export interface FetchTasksRequest { */ traverseTaskTree?: boolean; /** - * Only return Users whose name contains this text. + * Only return Tasks whose breadcrumb path contains all words in this query. */ name?: string; /** diff --git a/spec/openapi.yaml b/spec/openapi.yaml index e0e8159..3f725c7 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -10,7 +10,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.2.1 + version: 1.2.2 servers: - url: https://api.timr.com/v1/ @@ -2106,7 +2106,7 @@ paths: default: true - name: name in: query - description: Only return Users whose name contains this text. + description: Only return Tasks whose breadcrumb path contains all words in this query. required: false schema: type: string