Document workflow/run/task search query fields

GitOrigin-RevId: 683849f868d9237d43f7a9cbc49f1e3cdb87b5a2
gretelai · Jul 24, 2024 · 41fd187 · 41fd187
1 parent 6fdd215
commit 41fd187
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 16 deletions.
diff --git a/src/gretel_client/rest_v1/api/connections_api.py b/src/gretel_client/rest_v1/api/connections_api.py
@@ -1081,7 +1081,7 @@ def search_connections(
         query: Annotated[
             Optional[StrictStr],
             Field(
-                description="Query string to filter connections. Supported query fields are: `project_id`"
+                description="Query string to filter connections. Supported fields are: `project_id`"
             ),
         ] = None,
         sort: Annotated[
@@ -1111,7 +1111,7 @@ def search_connections(
         >>> thread = api.search_connections(query, sort, limit, skip, async_req=True)
         >>> result = thread.get()
 
-        :param query: Query string to filter connections. Supported query fields are: `project_id`
+        :param query: Query string to filter connections. Supported fields are: `project_id`
         :type query: str
         :param sort: Sort order for connections. Supported sort fields are: `created_at`, `updated_at`
         :type sort: str
@@ -1145,7 +1145,7 @@ def search_connections_with_http_info(
         query: Annotated[
             Optional[StrictStr],
             Field(
-                description="Query string to filter connections. Supported query fields are: `project_id`"
+                description="Query string to filter connections. Supported fields are: `project_id`"
             ),
         ] = None,
         sort: Annotated[
@@ -1175,7 +1175,7 @@ def search_connections_with_http_info(
         >>> thread = api.search_connections_with_http_info(query, sort, limit, skip, async_req=True)
         >>> result = thread.get()
 
-        :param query: Query string to filter connections. Supported query fields are: `project_id`
+        :param query: Query string to filter connections. Supported fields are: `project_id`
         :type query: str
         :param sort: Sort order for connections. Supported sort fields are: `created_at`, `updated_at`
         :type sort: str

diff --git a/src/gretel_client/rest_v1/api/workflows_api.py b/src/gretel_client/rest_v1/api/workflows_api.py
@@ -1331,7 +1331,9 @@ def search_workflow_runs(
         self,
         query: Annotated[
             Optional[StrictStr],
-            Field(description="The query string for searching workflow runs."),
+            Field(
+                description="The query string for searching workflow runs. Supported fields are: `id`, `workflow_id`, `project_id`, `status`, `runner_mode`, `cancelation_request`"
+            ),
         ] = None,
         expand: Annotated[
             Optional[conlist(StrictStr)],
@@ -1364,7 +1366,7 @@ def search_workflow_runs(
         >>> thread = api.search_workflow_runs(query, expand, limit, skip, sort, async_req=True)
         >>> result = thread.get()
 
-        :param query: The query string for searching workflow runs.
+        :param query: The query string for searching workflow runs. Supported fields are: `id`, `workflow_id`, `project_id`, `status`, `runner_mode`, `cancelation_request`
         :type query: str
         :param expand: The fields to expand in the search results. Supported values are: `project`, `config.system`, `created_by`
         :type expand: List[str]
@@ -1399,7 +1401,9 @@ def search_workflow_runs_with_http_info(
         self,
         query: Annotated[
             Optional[StrictStr],
-            Field(description="The query string for searching workflow runs."),
+            Field(
+                description="The query string for searching workflow runs. Supported fields are: `id`, `workflow_id`, `project_id`, `status`, `runner_mode`, `cancelation_request`"
+            ),
         ] = None,
         expand: Annotated[
             Optional[conlist(StrictStr)],
@@ -1432,7 +1436,7 @@ def search_workflow_runs_with_http_info(
         >>> thread = api.search_workflow_runs_with_http_info(query, expand, limit, skip, sort, async_req=True)
         >>> result = thread.get()
 
-        :param query: The query string for searching workflow runs.
+        :param query: The query string for searching workflow runs. Supported fields are: `id`, `workflow_id`, `project_id`, `status`, `runner_mode`, `cancelation_request`
         :type query: str
         :param expand: The fields to expand in the search results. Supported values are: `project`, `config.system`, `created_by`
         :type expand: List[str]
@@ -1558,7 +1562,9 @@ def search_workflow_tasks(
         self,
         query: Annotated[
             Optional[StrictStr],
-            Field(description="The query string for searching workflow tasks."),
+            Field(
+                description="The query string for searching workflow tasks. Supported fields are: `workflow_run_id`"
+            ),
         ] = None,
         limit: Annotated[
             Optional[StrictInt],
@@ -1587,7 +1593,7 @@ def search_workflow_tasks(
         >>> thread = api.search_workflow_tasks(query, limit, skip, expand, async_req=True)
         >>> result = thread.get()
 
-        :param query: The query string for searching workflow tasks.
+        :param query: The query string for searching workflow tasks. Supported fields are: `workflow_run_id`
         :type query: str
         :param limit: The maximum number of results to return.
         :type limit: int
@@ -1620,7 +1626,9 @@ def search_workflow_tasks_with_http_info(
         self,
         query: Annotated[
             Optional[StrictStr],
-            Field(description="The query string for searching workflow tasks."),
+            Field(
+                description="The query string for searching workflow tasks. Supported fields are: `workflow_run_id`"
+            ),
         ] = None,
         limit: Annotated[
             Optional[StrictInt],
@@ -1649,7 +1657,7 @@ def search_workflow_tasks_with_http_info(
         >>> thread = api.search_workflow_tasks_with_http_info(query, limit, skip, expand, async_req=True)
         >>> result = thread.get()
 
-        :param query: The query string for searching workflow tasks.
+        :param query: The query string for searching workflow tasks. Supported fields are: `workflow_run_id`
         :type query: str
         :param limit: The maximum number of results to return.
         :type limit: int
@@ -1770,7 +1778,9 @@ def search_workflows(
         self,
         query: Annotated[
             Optional[StrictStr],
-            Field(description="The query string for searching workflows."),
+            Field(
+                description="The query string for searching workflows. Supported fields are: `id`, `project_id`"
+            ),
         ] = None,
         sort: Annotated[
             Optional[StrictStr],
@@ -1803,7 +1813,7 @@ def search_workflows(
         >>> thread = api.search_workflows(query, sort, limit, skip, expand, async_req=True)
         >>> result = thread.get()
 
-        :param query: The query string for searching workflows.
+        :param query: The query string for searching workflows. Supported fields are: `id`, `project_id`
         :type query: str
         :param sort: The sort order for the search results.
         :type sort: str
@@ -1838,7 +1848,9 @@ def search_workflows_with_http_info(
         self,
         query: Annotated[
             Optional[StrictStr],
-            Field(description="The query string for searching workflows."),
+            Field(
+                description="The query string for searching workflows. Supported fields are: `id`, `project_id`"
+            ),
         ] = None,
         sort: Annotated[
             Optional[StrictStr],
@@ -1871,7 +1883,7 @@ def search_workflows_with_http_info(
         >>> thread = api.search_workflows_with_http_info(query, sort, limit, skip, expand, async_req=True)
         >>> result = thread.get()
 
-        :param query: The query string for searching workflows.
+        :param query: The query string for searching workflows. Supported fields are: `id`, `project_id`
         :type query: str
         :param sort: The sort order for the search results.
         :type sort: str