feat(backend/api,dashboard): add server-side recentlyCompleted sort for ListWorkflows

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 193
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-7a4f235379c078f7947364104260063f605613df775ccb0fe8d3710810589bc5.yml
-openapi_spec_hash: 2afba992f3e6ed516002fb391d54d7b4
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-eb4b27e6f97d8a8ebb2a75f24367f74153abb7d3a7c16c9110fc0af1be6ed8c9.yml
+openapi_spec_hash: e1a8fd3ecf7c9ca8b7639857f56defc2
 config_hash: 832c76d9cd88fc815f872ad64998911a

src/gitpod/resources/automations.py

@@ -345,17 +345,22 @@ def list(
         page_size: int | Omit = omit,
         filter: automation_list_params.Filter | Omit = omit,
         pagination: automation_list_params.Pagination | Omit = omit,
+        sort: automation_list_params.Sort | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncWorkflowsPage[Workflow]:
-        """
-        ListWorkflows
+        """ListWorkflows
 
         Args:
+          sort: sort specifies the order of results.
+
+        When unspecified, results are sorted
+              alphabetically by name ascending.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -371,6 +376,7 @@ def list(
                 {
                     "filter": filter,
                     "pagination": pagination,
+                    "sort": sort,
                 },
                 automation_list_params.AutomationListParams,
             ),
@@ -1238,17 +1244,22 @@ def list(
         page_size: int | Omit = omit,
         filter: automation_list_params.Filter | Omit = omit,
         pagination: automation_list_params.Pagination | Omit = omit,
+        sort: automation_list_params.Sort | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[Workflow, AsyncWorkflowsPage[Workflow]]:
-        """
-        ListWorkflows
+        """ListWorkflows
 
         Args:
+          sort: sort specifies the order of results.
+
+        When unspecified, results are sorted
+              alphabetically by name ascending.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1264,6 +1275,7 @@ def list(
                 {
                     "filter": filter,
                     "pagination": pagination,
+                    "sort": sort,
                 },
                 automation_list_params.AutomationListParams,
             ),

src/gitpod/types/automation_list_params.py

@@ -8,8 +8,9 @@
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
+from .shared.sort_order import SortOrder
 
-__all__ = ["AutomationListParams", "Filter", "Pagination"]
+__all__ = ["AutomationListParams", "Filter", "Pagination", "Sort"]
 
 
 class AutomationListParams(TypedDict, total=False):
@@ -21,6 +22,12 @@ class AutomationListParams(TypedDict, total=False):
 
     pagination: Pagination
 
+    sort: Sort
+    """sort specifies the order of results.
+
+    When unspecified, results are sorted alphabetically by name ascending.
+    """
+
 
 class Filter(TypedDict, total=False):
     creator_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="creatorIds")]
@@ -79,3 +86,15 @@ class Pagination(TypedDict, total=False):
 
     Maximum 100.
     """
+
+
+class Sort(TypedDict, total=False):
+    """sort specifies the order of results.
+
+    When unspecified, results are sorted
+     alphabetically by name ascending.
+    """
+
+    field: Literal["SORT_FIELD_UNSPECIFIED", "SORT_FIELD_NAME", "SORT_FIELD_RECENTLY_COMPLETED"]
+
+    order: SortOrder

tests/api_resources/test_automations.py

@@ -393,6 +393,10 @@ def test_method_list_with_all_params(self, client: Gitpod) -> None:
                 "token": "token",
                 "page_size": 100,
             },
+            sort={
+                "field": "SORT_FIELD_UNSPECIFIED",
+                "order": "SORT_ORDER_UNSPECIFIED",
+            },
         )
         assert_matches_type(SyncWorkflowsPage[Workflow], automation, path=["response"])
 
@@ -1152,6 +1156,10 @@ async def test_method_list_with_all_params(self, async_client: AsyncGitpod) -> N
                 "token": "token",
                 "page_size": 100,
             },
+            sort={
+                "field": "SORT_FIELD_UNSPECIFIED",
+                "order": "SORT_ORDER_UNSPECIFIED",
+            },
         )
         assert_matches_type(AsyncWorkflowsPage[Workflow], automation, path=["response"])