[QI2-1637] CRS protocol version negotiation

Author: Mythir

compute_api_client/api/backend_types_api.py

@@ -337,6 +337,8 @@ async def read_backend_types_backend_types_get(
         max_number_of_shots: Optional[StrictInt] = None,
         enabled: Optional[StrictBool] = None,
         identifier: Optional[StrictStr] = None,
+        protocol_version__isnull: Optional[StrictBool] = None,
+        protocol_version: Optional[StrictInt] = 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,
@@ -384,6 +386,10 @@ async def read_backend_types_backend_types_get(
         :type enabled: bool
         :param identifier:
         :type identifier: str
+        :param protocol_version__isnull:
+        :type protocol_version__isnull: bool
+        :param protocol_version:
+        :type protocol_version: int
         :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.
@@ -428,6 +434,8 @@ async def read_backend_types_backend_types_get(
             max_number_of_shots=max_number_of_shots,
             enabled=enabled,
             identifier=identifier,
+            protocol_version__isnull=protocol_version__isnull,
+            protocol_version=protocol_version,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -470,6 +478,8 @@ async def read_backend_types_backend_types_get_with_http_info(
         max_number_of_shots: Optional[StrictInt] = None,
         enabled: Optional[StrictBool] = None,
         identifier: Optional[StrictStr] = None,
+        protocol_version__isnull: Optional[StrictBool] = None,
+        protocol_version: Optional[StrictInt] = 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,
@@ -517,6 +527,10 @@ async def read_backend_types_backend_types_get_with_http_info(
         :type enabled: bool
         :param identifier:
         :type identifier: str
+        :param protocol_version__isnull:
+        :type protocol_version__isnull: bool
+        :param protocol_version:
+        :type protocol_version: int
         :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.
@@ -561,6 +575,8 @@ async def read_backend_types_backend_types_get_with_http_info(
             max_number_of_shots=max_number_of_shots,
             enabled=enabled,
             identifier=identifier,
+            protocol_version__isnull=protocol_version__isnull,
+            protocol_version=protocol_version,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -603,6 +619,8 @@ async def read_backend_types_backend_types_get_without_preload_content(
         max_number_of_shots: Optional[StrictInt] = None,
         enabled: Optional[StrictBool] = None,
         identifier: Optional[StrictStr] = None,
+        protocol_version__isnull: Optional[StrictBool] = None,
+        protocol_version: Optional[StrictInt] = 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,
@@ -650,6 +668,10 @@ async def read_backend_types_backend_types_get_without_preload_content(
         :type enabled: bool
         :param identifier:
         :type identifier: str
+        :param protocol_version__isnull:
+        :type protocol_version__isnull: bool
+        :param protocol_version:
+        :type protocol_version: int
         :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.
@@ -694,6 +716,8 @@ async def read_backend_types_backend_types_get_without_preload_content(
             max_number_of_shots=max_number_of_shots,
             enabled=enabled,
             identifier=identifier,
+            protocol_version__isnull=protocol_version__isnull,
+            protocol_version=protocol_version,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -731,6 +755,8 @@ def _read_backend_types_backend_types_get_serialize(
         max_number_of_shots,
         enabled,
         identifier,
+        protocol_version__isnull,
+        protocol_version,
         sort_by,
         latest,
         page,
@@ -808,6 +834,14 @@ def _read_backend_types_backend_types_get_serialize(
 
             _query_params.append(('identifier', identifier))
 
+        if protocol_version__isnull is not None:
+            
+            _query_params.append(('protocol_version__isnull', protocol_version__isnull))
+            
+        if protocol_version is not None:
+            
+            _query_params.append(('protocol_version', protocol_version))
+            
         if sort_by is not None:
 
             _query_params.append(('sort_by', sort_by))

compute_api_client/docs/BackendType.md

@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **max_number_of_shots** | **int** |  | 
 **enabled** | **bool** |  | 
 **identifier** | **str** |  | 
+**protocol_version** | **int** |  | [optional] 
 
 ## Example
 

compute_api_client/docs/BackendTypePatch.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **max_number_of_shots** | **int** |  | [optional] 
 **enabled** | **bool** |  | [optional] 
 **identifier** | **str** |  | [optional] 
+**protocol_version** | **int** |  | [optional] 
 
 ## Example
 

compute_api_client/docs/BackendTypesApi.md

@@ -93,7 +93,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_backend_types_backend_types_get**
-> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, identifier=identifier, sort_by=sort_by, latest=latest, page=page, size=size)
+> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, identifier=identifier, protocol_version__isnull=protocol_version__isnull, protocol_version=protocol_version, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List backend types
 
@@ -134,14 +134,16 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     max_number_of_shots = 56 # int |  (optional)
     enabled = True # bool |  (optional)
     identifier = 'identifier_example' # str |  (optional)
+    protocol_version__isnull = True # bool |  (optional)
+    protocol_version = 56 # int |  (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 backend types
-        api_response = await api_instance.read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, identifier=identifier, sort_by=sort_by, latest=latest, page=page, size=size)
+        api_response = await api_instance.read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, identifier=identifier, protocol_version__isnull=protocol_version__isnull, protocol_version=protocol_version, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -167,6 +169,8 @@ Name | Type | Description  | Notes
  **max_number_of_shots** | **int**|  | [optional] 
  **enabled** | **bool**|  | [optional] 
  **identifier** | **str**|  | [optional] 
+ **protocol_version__isnull** | **bool**|  | [optional] 
+ **protocol_version** | **int**|  | [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/backend_type.py

@@ -18,7 +18,7 @@
 import json
 
 
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
 from pydantic import Field
 from typing_extensions import Annotated
@@ -49,7 +49,8 @@ class BackendType(BaseModel):
     max_number_of_shots: StrictInt
     enabled: StrictBool
     identifier: Annotated[str, Field(strict=True, max_length=32)]
-    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier"]
+    protocol_version: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier", "protocol_version"]
 
     model_config = {
         "populate_by_name": True,
@@ -87,6 +88,11 @@ def to_dict(self) -> Dict[str, Any]:
             },
             exclude_none=True,
         )
+        # set to None if protocol_version (nullable) is None
+        # and model_fields_set contains the field
+        if self.protocol_version is None and "protocol_version" in self.model_fields_set:
+            _dict['protocol_version'] = None
+
         return _dict
 
     @classmethod
@@ -115,7 +121,8 @@ def from_dict(cls, obj: Dict) -> Self:
             "default_number_of_shots": obj.get("default_number_of_shots"),
             "max_number_of_shots": obj.get("max_number_of_shots"),
             "enabled": obj.get("enabled"),
-            "identifier": obj.get("identifier")
+            "identifier": obj.get("identifier"),
+            "protocol_version": obj.get("protocol_version")
         })
         return _obj
 

compute_api_client/models/backend_type_patch.py

@@ -46,7 +46,8 @@ class BackendTypePatch(BaseModel):
     max_number_of_shots: Optional[StrictInt] = None
     enabled: Optional[StrictBool] = None
     identifier: Optional[Annotated[str, Field(strict=True, max_length=32)]] = None
-    __properties: ClassVar[List[str]] = ["name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier"]
+    protocol_version: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier", "protocol_version"]
 
     model_config = {
         "populate_by_name": True,
@@ -159,6 +160,11 @@ def to_dict(self) -> Dict[str, Any]:
         if self.identifier is None and "identifier" in self.model_fields_set:
             _dict['identifier'] = None
 
+        # set to None if protocol_version (nullable) is None
+        # and model_fields_set contains the field
+        if self.protocol_version is None and "protocol_version" in self.model_fields_set:
+            _dict['protocol_version'] = None
+
         return _dict
 
     @classmethod
@@ -185,7 +191,8 @@ def from_dict(cls, obj: Dict) -> Self:
             "default_number_of_shots": obj.get("default_number_of_shots"),
             "max_number_of_shots": obj.get("max_number_of_shots"),
             "enabled": obj.get("enabled"),
-            "identifier": obj.get("identifier")
+            "identifier": obj.get("identifier"),
+            "protocol_version": obj.get("protocol_version")
         })
         return _obj
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qi-compute-api-client"
-version = "0.52.0"
+version = "0.53.0"
 description = "An API client for the Compute Job Manager of Quantum Inspire."
 authors = [{ name = "Quantum Inspire", email = "[email protected]" }]
 requires-python = "~=3.9"