[QI2-727] added optional name field to algorithms

Author: NischalQuTech

compute_api_client/api/algorithms_api.py

@@ -866,6 +866,8 @@ async def read_algorithms_algorithms_get(
         shared: Optional[ShareType] = None,
         link__isnull: Optional[StrictBool] = None,
         link: Optional[StrictStr] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -897,6 +899,10 @@ async def read_algorithms_algorithms_get(
         :type link__isnull: bool
         :param link:
         :type link: str
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -927,6 +933,8 @@ async def read_algorithms_algorithms_get(
             shared=shared,
             link__isnull=link__isnull,
             link=link,
+            name__isnull=name__isnull,
+            name=name,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -959,6 +967,8 @@ async def read_algorithms_algorithms_get_with_http_info(
         shared: Optional[ShareType] = None,
         link__isnull: Optional[StrictBool] = None,
         link: Optional[StrictStr] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -990,6 +1000,10 @@ async def read_algorithms_algorithms_get_with_http_info(
         :type link__isnull: bool
         :param link:
         :type link: str
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1020,6 +1034,8 @@ async def read_algorithms_algorithms_get_with_http_info(
             shared=shared,
             link__isnull=link__isnull,
             link=link,
+            name__isnull=name__isnull,
+            name=name,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1052,6 +1068,8 @@ async def read_algorithms_algorithms_get_without_preload_content(
         shared: Optional[ShareType] = None,
         link__isnull: Optional[StrictBool] = None,
         link: Optional[StrictStr] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1083,6 +1101,10 @@ async def read_algorithms_algorithms_get_without_preload_content(
         :type link__isnull: bool
         :param link:
         :type link: str
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1113,6 +1135,8 @@ async def read_algorithms_algorithms_get_without_preload_content(
             shared=shared,
             link__isnull=link__isnull,
             link=link,
+            name__isnull=name__isnull,
+            name=name,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1140,6 +1164,8 @@ def _read_algorithms_algorithms_get_serialize(
         shared,
         link__isnull,
         link,
+        name__isnull,
+        name,
         _request_auth,
         _content_type,
         _headers,
@@ -1189,6 +1215,14 @@ def _read_algorithms_algorithms_get_serialize(
 
             _query_params.append(('link', link))
 
+        if name__isnull is not None:
+            
+            _query_params.append(('name__isnull', name__isnull))
+            
+        if name is not None:
+            
+            _query_params.append(('name', name))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter

compute_api_client/docs/Algorithm.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **type** | [**AlgorithmType**](AlgorithmType.md) |  | 
 **shared** | [**ShareType**](ShareType.md) |  | 
 **link** | **str** |  | 
+**name** | **str** |  | 
 
 ## Example
 

compute_api_client/docs/AlgorithmIn.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **type** | [**AlgorithmType**](AlgorithmType.md) |  | 
 **shared** | [**ShareType**](ShareType.md) |  | 
 **link** | **str** |  | [optional] 
+**name** | **str** |  | [optional] 
 
 ## Example
 

compute_api_client/docs/AlgorithmsApi.md

@@ -256,7 +256,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_algorithms_algorithms_get**
-> List[Algorithm] read_algorithms_algorithms_get(latest=latest, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link)
+> List[Algorithm] read_algorithms_algorithms_get(latest=latest, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name__isnull=name__isnull, name=name)
 
 List algorithms
 
@@ -303,10 +303,12 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     shared = compute_api_client.ShareType() # ShareType |  (optional)
     link__isnull = True # bool |  (optional)
     link = 'link_example' # str |  (optional)
+    name__isnull = True # bool |  (optional)
+    name = 'name_example' # str |  (optional)
 
     try:
         # List algorithms
-        api_response = await api_instance.read_algorithms_algorithms_get(latest=latest, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link)
+        api_response = await api_instance.read_algorithms_algorithms_get(latest=latest, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name__isnull=name__isnull, name=name)
         print("The response of AlgorithmsApi->read_algorithms_algorithms_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -326,6 +328,8 @@ Name | Type | Description  | Notes
  **shared** | [**ShareType**](.md)|  | [optional] 
  **link__isnull** | **bool**|  | [optional] 
  **link** | **str**|  | [optional] 
+ **name__isnull** | **bool**|  | [optional] 
+ **name** | **str**|  | [optional] 
 
 ### Return type
 

compute_api_client/models/algorithm.py

@@ -38,7 +38,8 @@ class Algorithm(BaseModel):
     type: AlgorithmType
     shared: ShareType
     link: Optional[Annotated[str, Field(strict=True, max_length=255)]]
-    __properties: ClassVar[List[str]] = ["id", "project_id", "type", "shared", "link"]
+    name: Optional[Annotated[str, Field(strict=True, max_length=255)]]
+    __properties: ClassVar[List[str]] = ["id", "project_id", "type", "shared", "link", "name"]
 
     model_config = {
         "populate_by_name": True,
@@ -81,6 +82,11 @@ def to_dict(self) -> Dict[str, Any]:
         if self.link is None and "link" in self.model_fields_set:
             _dict['link'] = None
 
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
         return _dict
 
     @classmethod
@@ -97,7 +103,8 @@ def from_dict(cls, obj: Dict) -> Self:
             "project_id": obj.get("project_id"),
             "type": obj.get("type"),
             "shared": obj.get("shared"),
-            "link": obj.get("link")
+            "link": obj.get("link"),
+            "name": obj.get("name")
         })
         return _obj
 

compute_api_client/models/algorithm_in.py

@@ -37,7 +37,8 @@ class AlgorithmIn(BaseModel):
     type: AlgorithmType
     shared: ShareType
     link: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
-    __properties: ClassVar[List[str]] = ["project_id", "type", "shared", "link"]
+    name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    __properties: ClassVar[List[str]] = ["project_id", "type", "shared", "link", "name"]
 
     model_config = {
         "populate_by_name": True,
@@ -80,6 +81,11 @@ def to_dict(self) -> Dict[str, Any]:
         if self.link is None and "link" in self.model_fields_set:
             _dict['link'] = None
 
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
         return _dict
 
     @classmethod
@@ -95,7 +101,8 @@ def from_dict(cls, obj: Dict) -> Self:
             "project_id": obj.get("project_id"),
             "type": obj.get("type"),
             "shared": obj.get("shared"),
-            "link": obj.get("link")
+            "link": obj.get("link"),
+            "name": obj.get("name")
         })
         return _obj
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qi-compute-api-client"
-version = "0.18.0"
+version = "0.19.0"
 description = "An API client for the Compute Job Manager of Quantum Inspire."
 license = "Apache-2.0"
 authors = ["Quantum Inspire <support@quantum-inspire.eu>"]