[QI2-679] added sorting and pagination to list endpoints

README.md

@@ -1,5 +1,5 @@
 # compute-api-client
-No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
 
 The `compute_api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 

compute_api_client/__init__.py

@@ -5,7 +5,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)

compute_api_client/api/algorithms_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -860,6 +860,9 @@ def _read_algorithm_algorithms_id_get_serialize(
     async def read_algorithms_algorithms_get(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
@@ -887,6 +890,12 @@ async def read_algorithms_algorithms_get(
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param project_id:
@@ -927,6 +936,9 @@ async def read_algorithms_algorithms_get(
 
         _param = self._read_algorithms_algorithms_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
@@ -961,6 +973,9 @@ async def read_algorithms_algorithms_get(
     async def read_algorithms_algorithms_get_with_http_info(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
@@ -988,6 +1003,12 @@ async def read_algorithms_algorithms_get_with_http_info(
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param project_id:
@@ -1028,6 +1049,9 @@ async def read_algorithms_algorithms_get_with_http_info(
 
         _param = self._read_algorithms_algorithms_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
@@ -1062,6 +1086,9 @@ async def read_algorithms_algorithms_get_with_http_info(
     async def read_algorithms_algorithms_get_without_preload_content(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
@@ -1089,6 +1116,12 @@ async def read_algorithms_algorithms_get_without_preload_content(
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param project_id:
@@ -1129,6 +1162,9 @@ async def read_algorithms_algorithms_get_without_preload_content(
 
         _param = self._read_algorithms_algorithms_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
@@ -1158,6 +1194,9 @@ async def read_algorithms_algorithms_get_without_preload_content(
     def _read_algorithms_algorithms_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         project_id,
         type,
@@ -1191,6 +1230,18 @@ def _read_algorithms_algorithms_get_serialize(
 
             _query_params.append(('latest', latest))
 
+        if sort_by is not None:
+
+            _query_params.append(('sort_by', sort_by))
+
+        if page_number is not None:
+
+            _query_params.append(('page_number', page_number))
+
+        if items_per_page is not None:
+
+            _query_params.append(('items_per_page', items_per_page))
+
         if id is not None:
 
             _query_params.append(('id', id))

compute_api_client/api/backend_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -849,6 +849,9 @@ def _read_backend_self_backends_me_get_serialize(
     async def read_backends_backends_get(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
         location: Optional[StrictStr] = None,
@@ -874,6 +877,12 @@ async def read_backends_backends_get(
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param name:
@@ -910,6 +919,9 @@ async def read_backends_backends_get(
 
         _param = self._read_backends_backends_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             name=name,
             location=location,
@@ -942,6 +954,9 @@ async def read_backends_backends_get(
     async def read_backends_backends_get_with_http_info(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
         location: Optional[StrictStr] = None,
@@ -967,6 +982,12 @@ async def read_backends_backends_get_with_http_info(
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param name:
@@ -1003,6 +1024,9 @@ async def read_backends_backends_get_with_http_info(
 
         _param = self._read_backends_backends_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             name=name,
             location=location,
@@ -1035,6 +1059,9 @@ async def read_backends_backends_get_with_http_info(
     async def read_backends_backends_get_without_preload_content(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
         location: Optional[StrictStr] = None,
@@ -1060,6 +1087,12 @@ async def read_backends_backends_get_without_preload_content(
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param name:
@@ -1096,6 +1129,9 @@ async def read_backends_backends_get_without_preload_content(
 
         _param = self._read_backends_backends_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             name=name,
             location=location,
@@ -1123,6 +1159,9 @@ async def read_backends_backends_get_without_preload_content(
     def _read_backends_backends_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         name,
         location,
@@ -1154,6 +1193,18 @@ def _read_backends_backends_get_serialize(
 
             _query_params.append(('latest', latest))
 
+        if sort_by is not None:
+
+            _query_params.append(('sort_by', sort_by))
+
+        if page_number is not None:
+
+            _query_params.append(('page_number', page_number))
+
+        if items_per_page is not None:
+
+            _query_params.append(('items_per_page', items_per_page))
+
         if id is not None:
 
             _query_params.append(('id', id))