[QI2-1100] Added name field to file

compute_api_client/api/files_api.py

@@ -867,6 +867,8 @@ async def read_files_files_get(
         language_id: Optional[StrictInt] = None,
         compile_stage: Optional[CompileStage] = None,
         generated: Optional[StrictBool] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
         latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
         page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
@@ -900,6 +902,10 @@ async def read_files_files_get(
         :type compile_stage: CompileStage
         :param generated:
         :type generated: bool
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
         :type sort_by: str
         :param latest: If True gets the most recently created object.
@@ -937,6 +943,8 @@ async def read_files_files_get(
             language_id=language_id,
             compile_stage=compile_stage,
             generated=generated,
+            name__isnull=name__isnull,
+            name=name,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -972,6 +980,8 @@ async def read_files_files_get_with_http_info(
         language_id: Optional[StrictInt] = None,
         compile_stage: Optional[CompileStage] = None,
         generated: Optional[StrictBool] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
         latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
         page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
@@ -1005,6 +1015,10 @@ async def read_files_files_get_with_http_info(
         :type compile_stage: CompileStage
         :param generated:
         :type generated: bool
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
         :type sort_by: str
         :param latest: If True gets the most recently created object.
@@ -1042,6 +1056,8 @@ async def read_files_files_get_with_http_info(
             language_id=language_id,
             compile_stage=compile_stage,
             generated=generated,
+            name__isnull=name__isnull,
+            name=name,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1077,6 +1093,8 @@ async def read_files_files_get_without_preload_content(
         language_id: Optional[StrictInt] = None,
         compile_stage: Optional[CompileStage] = None,
         generated: Optional[StrictBool] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
         latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
         page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
@@ -1110,6 +1128,10 @@ async def read_files_files_get_without_preload_content(
         :type compile_stage: CompileStage
         :param generated:
         :type generated: bool
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
         :type sort_by: str
         :param latest: If True gets the most recently created object.
@@ -1147,6 +1169,8 @@ async def read_files_files_get_without_preload_content(
             language_id=language_id,
             compile_stage=compile_stage,
             generated=generated,
+            name__isnull=name__isnull,
+            name=name,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1177,6 +1201,8 @@ def _read_files_files_get_serialize(
         language_id,
         compile_stage,
         generated,
+        name__isnull,
+        name,
         sort_by,
         latest,
         page,
@@ -1226,6 +1252,14 @@ def _read_files_files_get_serialize(
 
             _query_params.append(('generated', generated))
 
+        if name__isnull is not None:
+
+            _query_params.append(('name__isnull', name__isnull))
+
+        if name is not None:
+
+            _query_params.append(('name', name))
+
         if sort_by is not None:
 
             _query_params.append(('sort_by', sort_by))

compute_api_client/docs/File.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | 
 **compile_properties** | **object** |  | 
 **generated** | **bool** |  | 
+**name** | **str** |  | [optional] 
 
 ## Example
 

compute_api_client/docs/FileIn.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | 
 **compile_properties** | **object** |  | 
 **generated** | **bool** |  | [optional] [default to False]
+**name** | **str** |  | [optional] 
 
 ## Example
 

compute_api_client/docs/FilesApi.md

@@ -243,7 +243,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_files_files_get**
-> PageFile read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, sort_by=sort_by, latest=latest, page=page, size=size)
+> PageFile read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, name__isnull=name__isnull, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List files
 
@@ -284,14 +284,16 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     language_id = 56 # int |  (optional)
     compile_stage = compute_api_client.CompileStage() # CompileStage |  (optional)
     generated = True # bool |  (optional)
+    name__isnull = True # bool |  (optional)
+    name = 'name_example' # str |  (optional)
     sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
     latest = True # bool | If True gets the most recently created object. (optional)
     page = 1 # int | Page number (optional) (default to 1)
     size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List files
-        api_response = await api_instance.read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, sort_by=sort_by, latest=latest, page=page, size=size)
+        api_response = await api_instance.read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, name__isnull=name__isnull, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of FilesApi->read_files_files_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -310,6 +312,8 @@ Name | Type | Description  | Notes
  **language_id** | **int**|  | [optional] 
  **compile_stage** | [**CompileStage**](.md)|  | [optional] 
  **generated** | **bool**|  | [optional] 
+ **name__isnull** | **bool**|  | [optional] 
+ **name** | **str**|  | [optional] 
  **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
  **latest** | **bool**| If True gets the most recently created object. | [optional] 
  **page** | **int**| Page number | [optional] [default to 1]

compute_api_client/models/file.py

@@ -18,8 +18,10 @@
 import json
 
 
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
 from compute_api_client.models.compile_stage import CompileStage
 try:
     from typing import Self
@@ -37,7 +39,8 @@ class File(BaseModel):
     compile_stage: CompileStage
     compile_properties: Union[str, Any]
     generated: StrictBool
-    __properties: ClassVar[List[str]] = ["id", "commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated"]
+    name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    __properties: ClassVar[List[str]] = ["id", "commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated", "name"]
 
     model_config = {
         "populate_by_name": True,
@@ -75,6 +78,11 @@ def to_dict(self) -> Dict[str, Any]:
             },
             exclude_none=True,
         )
+        # 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
@@ -93,7 +101,8 @@ def from_dict(cls, obj: Dict) -> Self:
             "language_id": obj.get("language_id"),
             "compile_stage": obj.get("compile_stage"),
             "compile_properties": obj.get("compile_properties"),
-            "generated": obj.get("generated")
+            "generated": obj.get("generated"),
+            "name": obj.get("name")
         })
         return _obj
 

compute_api_client/models/file_in.py

@@ -20,6 +20,8 @@
 
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
 from compute_api_client.models.compile_stage import CompileStage
 try:
     from typing import Self
@@ -36,7 +38,8 @@ class FileIn(BaseModel):
     compile_stage: CompileStage
     compile_properties: Union[str, Any]
     generated: Optional[StrictBool] = False
-    __properties: ClassVar[List[str]] = ["commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated"]
+    name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    __properties: ClassVar[List[str]] = ["commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated", "name"]
 
     model_config = {
         "populate_by_name": True,
@@ -74,6 +77,11 @@ def to_dict(self) -> Dict[str, Any]:
             },
             exclude_none=True,
         )
+        # 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
@@ -91,7 +99,8 @@ def from_dict(cls, obj: Dict) -> Self:
             "language_id": obj.get("language_id"),
             "compile_stage": obj.get("compile_stage"),
             "compile_properties": obj.get("compile_properties"),
-            "generated": obj.get("generated") if obj.get("generated") is not None else False
+            "generated": obj.get("generated") if obj.get("generated") is not None else False,
+            "name": obj.get("name")
         })
         return _obj
 

pyproject.toml

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