qi-compute-api-client 0.32.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of qi-compute-api-client might be problematic. Click here for more details.

Files changed (134) hide show
  1. compute_api_client/__init__.py +20 -1
  2. compute_api_client/api/__init__.py +1 -0
  3. compute_api_client/api/algorithms_api.py +76 -75
  4. compute_api_client/api/backend_api.py +78 -75
  5. compute_api_client/api/backend_types_api.py +95 -75
  6. compute_api_client/api/batch_jobs_api.py +77 -74
  7. compute_api_client/api/commits_api.py +78 -75
  8. compute_api_client/api/files_api.py +78 -75
  9. compute_api_client/api/final_results_api.py +1 -1
  10. compute_api_client/api/health_api.py +290 -0
  11. compute_api_client/api/jobs_api.py +78 -75
  12. compute_api_client/api/languages_api.py +76 -73
  13. compute_api_client/api/members_api.py +78 -75
  14. compute_api_client/api/metadata_api.py +79 -8
  15. compute_api_client/api/permissions_api.py +146 -142
  16. compute_api_client/api/projects_api.py +76 -75
  17. compute_api_client/api/reservations_api.py +78 -75
  18. compute_api_client/api/results_api.py +151 -80
  19. compute_api_client/api/teams_api.py +78 -75
  20. compute_api_client/api/transactions_api.py +78 -75
  21. compute_api_client/api/users_api.py +78 -75
  22. compute_api_client/api_client.py +1 -1
  23. compute_api_client/configuration.py +1 -1
  24. compute_api_client/docs/AlgorithmsApi.md +12 -12
  25. compute_api_client/docs/BackendApi.md +12 -12
  26. compute_api_client/docs/BackendType.md +3 -1
  27. compute_api_client/docs/BackendTypesApi.md +14 -12
  28. compute_api_client/docs/BatchJobsApi.md +12 -12
  29. compute_api_client/docs/CommitsApi.md +12 -12
  30. compute_api_client/docs/FilesApi.md +12 -12
  31. compute_api_client/docs/HealthApi.md +71 -0
  32. compute_api_client/docs/JobsApi.md +12 -12
  33. compute_api_client/docs/LanguagesApi.md +12 -12
  34. compute_api_client/docs/MembersApi.md +12 -12
  35. compute_api_client/docs/MetadataApi.md +12 -4
  36. compute_api_client/docs/PageAlgorithm.md +32 -0
  37. compute_api_client/docs/PageBackend.md +32 -0
  38. compute_api_client/docs/PageBackendType.md +32 -0
  39. compute_api_client/docs/PageBatchJob.md +32 -0
  40. compute_api_client/docs/PageCommit.md +32 -0
  41. compute_api_client/docs/PageFile.md +32 -0
  42. compute_api_client/docs/PageJob.md +32 -0
  43. compute_api_client/docs/PageLanguage.md +32 -0
  44. compute_api_client/docs/PageMember.md +32 -0
  45. compute_api_client/docs/PageMetadata.md +32 -0
  46. compute_api_client/docs/PagePermission.md +32 -0
  47. compute_api_client/docs/PagePermissionGroup.md +32 -0
  48. compute_api_client/docs/PageProject.md +32 -0
  49. compute_api_client/docs/PageReservation.md +32 -0
  50. compute_api_client/docs/PageResult.md +32 -0
  51. compute_api_client/docs/PageTeam.md +32 -0
  52. compute_api_client/docs/PageTransaction.md +32 -0
  53. compute_api_client/docs/PageUser.md +32 -0
  54. compute_api_client/docs/PermissionsApi.md +24 -24
  55. compute_api_client/docs/ProjectsApi.md +12 -12
  56. compute_api_client/docs/ReservationsApi.md +12 -12
  57. compute_api_client/docs/ResultsApi.md +24 -16
  58. compute_api_client/docs/TeamsApi.md +12 -12
  59. compute_api_client/docs/TransactionsApi.md +12 -12
  60. compute_api_client/docs/UsersApi.md +12 -12
  61. compute_api_client/exceptions.py +1 -1
  62. compute_api_client/models/__init__.py +19 -1
  63. compute_api_client/models/algorithm.py +1 -1
  64. compute_api_client/models/algorithm_in.py +1 -1
  65. compute_api_client/models/algorithm_type.py +1 -1
  66. compute_api_client/models/backend.py +1 -1
  67. compute_api_client/models/backend_in.py +1 -1
  68. compute_api_client/models/backend_patch.py +1 -1
  69. compute_api_client/models/backend_status.py +1 -1
  70. compute_api_client/models/backend_type.py +8 -4
  71. compute_api_client/models/backend_with_authentication.py +1 -1
  72. compute_api_client/models/batch_job.py +1 -1
  73. compute_api_client/models/batch_job_in.py +1 -1
  74. compute_api_client/models/batch_job_status.py +1 -1
  75. compute_api_client/models/commit.py +1 -1
  76. compute_api_client/models/commit_in.py +1 -1
  77. compute_api_client/models/compile_stage.py +1 -1
  78. compute_api_client/models/domain.py +1 -1
  79. compute_api_client/models/file.py +1 -1
  80. compute_api_client/models/file_in.py +1 -1
  81. compute_api_client/models/final_result.py +1 -1
  82. compute_api_client/models/final_result_in.py +1 -1
  83. compute_api_client/models/http_not_found_error.py +1 -1
  84. compute_api_client/models/http_validation_error.py +1 -1
  85. compute_api_client/models/job.py +1 -1
  86. compute_api_client/models/job_in.py +1 -1
  87. compute_api_client/models/job_patch.py +1 -1
  88. compute_api_client/models/job_status.py +1 -1
  89. compute_api_client/models/language.py +1 -1
  90. compute_api_client/models/location_inner.py +1 -1
  91. compute_api_client/models/member.py +1 -1
  92. compute_api_client/models/member_in.py +1 -1
  93. compute_api_client/models/metadata.py +1 -1
  94. compute_api_client/models/metadata_in.py +1 -1
  95. compute_api_client/models/page_algorithm.py +125 -0
  96. compute_api_client/models/page_backend.py +125 -0
  97. compute_api_client/models/page_backend_type.py +125 -0
  98. compute_api_client/models/page_batch_job.py +125 -0
  99. compute_api_client/models/page_commit.py +125 -0
  100. compute_api_client/models/page_file.py +125 -0
  101. compute_api_client/models/page_job.py +125 -0
  102. compute_api_client/models/page_language.py +125 -0
  103. compute_api_client/models/page_member.py +125 -0
  104. compute_api_client/models/page_metadata.py +125 -0
  105. compute_api_client/models/page_permission.py +125 -0
  106. compute_api_client/models/page_permission_group.py +125 -0
  107. compute_api_client/models/page_project.py +125 -0
  108. compute_api_client/models/page_reservation.py +125 -0
  109. compute_api_client/models/page_result.py +125 -0
  110. compute_api_client/models/page_team.py +125 -0
  111. compute_api_client/models/page_transaction.py +125 -0
  112. compute_api_client/models/page_user.py +125 -0
  113. compute_api_client/models/permission.py +1 -1
  114. compute_api_client/models/permission_group.py +1 -1
  115. compute_api_client/models/project.py +1 -1
  116. compute_api_client/models/project_in.py +1 -1
  117. compute_api_client/models/project_patch.py +1 -1
  118. compute_api_client/models/reservation.py +1 -1
  119. compute_api_client/models/reservation_in.py +1 -1
  120. compute_api_client/models/result.py +1 -1
  121. compute_api_client/models/result_in.py +1 -1
  122. compute_api_client/models/role.py +1 -1
  123. compute_api_client/models/share_type.py +1 -1
  124. compute_api_client/models/team.py +1 -1
  125. compute_api_client/models/transaction.py +1 -1
  126. compute_api_client/models/user.py +1 -1
  127. compute_api_client/models/user_in.py +1 -1
  128. compute_api_client/models/validation_error.py +1 -1
  129. compute_api_client/rest.py +1 -1
  130. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.35.0.dist-info}/METADATA +22 -3
  131. qi_compute_api_client-0.35.0.dist-info/RECORD +182 -0
  132. qi_compute_api_client-0.32.0.dist-info/RECORD +0 -144
  133. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.35.0.dist-info}/LICENSE.md +0 -0
  134. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.35.0.dist-info}/WHEEL +0 -0
@@ -3,7 +3,7 @@
3
3
  """
4
4
  Quantum Inspire 2
5
5
 
6
- **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.
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
7
 
8
8
  The version of the OpenAPI document: 0.1.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -23,10 +23,13 @@ try:
23
23
  except ImportError:
24
24
  from typing_extensions import Annotated
25
25
 
26
+ from pydantic import Field
27
+ from typing_extensions import Annotated
26
28
  from pydantic import StrictBool, StrictInt, StrictStr
27
29
 
28
- from typing import List, Optional
30
+ from typing import Optional
29
31
 
32
+ from compute_api_client.models.page_user import PageUser
30
33
  from compute_api_client.models.user import User
31
34
  from compute_api_client.models.user_in import UserIn
32
35
 
@@ -856,10 +859,6 @@ class UsersApi:
856
859
  @validate_call
857
860
  async def read_users_users_get(
858
861
  self,
859
- latest: Optional[StrictBool] = None,
860
- sort_by: Optional[StrictStr] = None,
861
- page_number: Optional[StrictInt] = None,
862
- items_per_page: Optional[StrictInt] = None,
863
862
  id: Optional[StrictInt] = None,
864
863
  full_name: Optional[StrictStr] = None,
865
864
  email: Optional[StrictStr] = None,
@@ -868,6 +867,10 @@ class UsersApi:
868
867
  is_active: Optional[StrictBool] = None,
869
868
  is_confirmed: Optional[StrictBool] = None,
870
869
  oidc_sub: Optional[StrictStr] = None,
870
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
871
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
872
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
873
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
871
874
  _request_timeout: Union[
872
875
  None,
873
876
  Annotated[StrictFloat, Field(gt=0)],
@@ -880,19 +883,11 @@ class UsersApi:
880
883
  _content_type: Optional[StrictStr] = None,
881
884
  _headers: Optional[Dict[StrictStr, Any]] = None,
882
885
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
883
- ) -> List[User]:
886
+ ) -> PageUser:
884
887
  """List users
885
888
 
886
889
  Read users.
887
890
 
888
- :param latest:
889
- :type latest: bool
890
- :param sort_by:
891
- :type sort_by: str
892
- :param page_number:
893
- :type page_number: int
894
- :param items_per_page:
895
- :type items_per_page: int
896
891
  :param id:
897
892
  :type id: int
898
893
  :param full_name:
@@ -909,6 +904,14 @@ class UsersApi:
909
904
  :type is_confirmed: bool
910
905
  :param oidc_sub:
911
906
  :type oidc_sub: str
907
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
908
+ :type sort_by: str
909
+ :param latest: If True gets the most recently created object.
910
+ :type latest: bool
911
+ :param page: Page number
912
+ :type page: int
913
+ :param size: Page size
914
+ :type size: int
912
915
  :param _request_timeout: timeout setting for this request. If one
913
916
  number provided, it will be total request
914
917
  timeout. It can also be a pair (tuple) of
@@ -932,10 +935,6 @@ class UsersApi:
932
935
  """ # noqa: E501
933
936
 
934
937
  _param = self._read_users_users_get_serialize(
935
- latest=latest,
936
- sort_by=sort_by,
937
- page_number=page_number,
938
- items_per_page=items_per_page,
939
938
  id=id,
940
939
  full_name=full_name,
941
940
  email=email,
@@ -944,6 +943,10 @@ class UsersApi:
944
943
  is_active=is_active,
945
944
  is_confirmed=is_confirmed,
946
945
  oidc_sub=oidc_sub,
946
+ sort_by=sort_by,
947
+ latest=latest,
948
+ page=page,
949
+ size=size,
947
950
  _request_auth=_request_auth,
948
951
  _content_type=_content_type,
949
952
  _headers=_headers,
@@ -951,7 +954,7 @@ class UsersApi:
951
954
  )
952
955
 
953
956
  _response_types_map: Dict[str, Optional[str]] = {
954
- '200': "List[User]",
957
+ '200': "PageUser",
955
958
  '422': "HTTPValidationError"
956
959
 
957
960
  }
@@ -969,10 +972,6 @@ class UsersApi:
969
972
  @validate_call
970
973
  async def read_users_users_get_with_http_info(
971
974
  self,
972
- latest: Optional[StrictBool] = None,
973
- sort_by: Optional[StrictStr] = None,
974
- page_number: Optional[StrictInt] = None,
975
- items_per_page: Optional[StrictInt] = None,
976
975
  id: Optional[StrictInt] = None,
977
976
  full_name: Optional[StrictStr] = None,
978
977
  email: Optional[StrictStr] = None,
@@ -981,6 +980,10 @@ class UsersApi:
981
980
  is_active: Optional[StrictBool] = None,
982
981
  is_confirmed: Optional[StrictBool] = None,
983
982
  oidc_sub: Optional[StrictStr] = None,
983
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
984
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
985
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
986
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
984
987
  _request_timeout: Union[
985
988
  None,
986
989
  Annotated[StrictFloat, Field(gt=0)],
@@ -993,19 +996,11 @@ class UsersApi:
993
996
  _content_type: Optional[StrictStr] = None,
994
997
  _headers: Optional[Dict[StrictStr, Any]] = None,
995
998
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
996
- ) -> ApiResponse[List[User]]:
999
+ ) -> ApiResponse[PageUser]:
997
1000
  """List users
998
1001
 
999
1002
  Read users.
1000
1003
 
1001
- :param latest:
1002
- :type latest: bool
1003
- :param sort_by:
1004
- :type sort_by: str
1005
- :param page_number:
1006
- :type page_number: int
1007
- :param items_per_page:
1008
- :type items_per_page: int
1009
1004
  :param id:
1010
1005
  :type id: int
1011
1006
  :param full_name:
@@ -1022,6 +1017,14 @@ class UsersApi:
1022
1017
  :type is_confirmed: bool
1023
1018
  :param oidc_sub:
1024
1019
  :type oidc_sub: str
1020
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1021
+ :type sort_by: str
1022
+ :param latest: If True gets the most recently created object.
1023
+ :type latest: bool
1024
+ :param page: Page number
1025
+ :type page: int
1026
+ :param size: Page size
1027
+ :type size: int
1025
1028
  :param _request_timeout: timeout setting for this request. If one
1026
1029
  number provided, it will be total request
1027
1030
  timeout. It can also be a pair (tuple) of
@@ -1045,10 +1048,6 @@ class UsersApi:
1045
1048
  """ # noqa: E501
1046
1049
 
1047
1050
  _param = self._read_users_users_get_serialize(
1048
- latest=latest,
1049
- sort_by=sort_by,
1050
- page_number=page_number,
1051
- items_per_page=items_per_page,
1052
1051
  id=id,
1053
1052
  full_name=full_name,
1054
1053
  email=email,
@@ -1057,6 +1056,10 @@ class UsersApi:
1057
1056
  is_active=is_active,
1058
1057
  is_confirmed=is_confirmed,
1059
1058
  oidc_sub=oidc_sub,
1059
+ sort_by=sort_by,
1060
+ latest=latest,
1061
+ page=page,
1062
+ size=size,
1060
1063
  _request_auth=_request_auth,
1061
1064
  _content_type=_content_type,
1062
1065
  _headers=_headers,
@@ -1064,7 +1067,7 @@ class UsersApi:
1064
1067
  )
1065
1068
 
1066
1069
  _response_types_map: Dict[str, Optional[str]] = {
1067
- '200': "List[User]",
1070
+ '200': "PageUser",
1068
1071
  '422': "HTTPValidationError"
1069
1072
 
1070
1073
  }
@@ -1082,10 +1085,6 @@ class UsersApi:
1082
1085
  @validate_call
1083
1086
  async def read_users_users_get_without_preload_content(
1084
1087
  self,
1085
- latest: Optional[StrictBool] = None,
1086
- sort_by: Optional[StrictStr] = None,
1087
- page_number: Optional[StrictInt] = None,
1088
- items_per_page: Optional[StrictInt] = None,
1089
1088
  id: Optional[StrictInt] = None,
1090
1089
  full_name: Optional[StrictStr] = None,
1091
1090
  email: Optional[StrictStr] = None,
@@ -1094,6 +1093,10 @@ class UsersApi:
1094
1093
  is_active: Optional[StrictBool] = None,
1095
1094
  is_confirmed: Optional[StrictBool] = None,
1096
1095
  oidc_sub: Optional[StrictStr] = None,
1096
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1097
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1098
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1099
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1097
1100
  _request_timeout: Union[
1098
1101
  None,
1099
1102
  Annotated[StrictFloat, Field(gt=0)],
@@ -1111,14 +1114,6 @@ class UsersApi:
1111
1114
 
1112
1115
  Read users.
1113
1116
 
1114
- :param latest:
1115
- :type latest: bool
1116
- :param sort_by:
1117
- :type sort_by: str
1118
- :param page_number:
1119
- :type page_number: int
1120
- :param items_per_page:
1121
- :type items_per_page: int
1122
1117
  :param id:
1123
1118
  :type id: int
1124
1119
  :param full_name:
@@ -1135,6 +1130,14 @@ class UsersApi:
1135
1130
  :type is_confirmed: bool
1136
1131
  :param oidc_sub:
1137
1132
  :type oidc_sub: str
1133
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1134
+ :type sort_by: str
1135
+ :param latest: If True gets the most recently created object.
1136
+ :type latest: bool
1137
+ :param page: Page number
1138
+ :type page: int
1139
+ :param size: Page size
1140
+ :type size: int
1138
1141
  :param _request_timeout: timeout setting for this request. If one
1139
1142
  number provided, it will be total request
1140
1143
  timeout. It can also be a pair (tuple) of
@@ -1158,10 +1161,6 @@ class UsersApi:
1158
1161
  """ # noqa: E501
1159
1162
 
1160
1163
  _param = self._read_users_users_get_serialize(
1161
- latest=latest,
1162
- sort_by=sort_by,
1163
- page_number=page_number,
1164
- items_per_page=items_per_page,
1165
1164
  id=id,
1166
1165
  full_name=full_name,
1167
1166
  email=email,
@@ -1170,6 +1169,10 @@ class UsersApi:
1170
1169
  is_active=is_active,
1171
1170
  is_confirmed=is_confirmed,
1172
1171
  oidc_sub=oidc_sub,
1172
+ sort_by=sort_by,
1173
+ latest=latest,
1174
+ page=page,
1175
+ size=size,
1173
1176
  _request_auth=_request_auth,
1174
1177
  _content_type=_content_type,
1175
1178
  _headers=_headers,
@@ -1177,7 +1180,7 @@ class UsersApi:
1177
1180
  )
1178
1181
 
1179
1182
  _response_types_map: Dict[str, Optional[str]] = {
1180
- '200': "List[User]",
1183
+ '200': "PageUser",
1181
1184
  '422': "HTTPValidationError"
1182
1185
 
1183
1186
  }
@@ -1190,10 +1193,6 @@ class UsersApi:
1190
1193
 
1191
1194
  def _read_users_users_get_serialize(
1192
1195
  self,
1193
- latest,
1194
- sort_by,
1195
- page_number,
1196
- items_per_page,
1197
1196
  id,
1198
1197
  full_name,
1199
1198
  email,
@@ -1202,6 +1201,10 @@ class UsersApi:
1202
1201
  is_active,
1203
1202
  is_confirmed,
1204
1203
  oidc_sub,
1204
+ sort_by,
1205
+ latest,
1206
+ page,
1207
+ size,
1205
1208
  _request_auth,
1206
1209
  _content_type,
1207
1210
  _headers,
@@ -1223,22 +1226,6 @@ class UsersApi:
1223
1226
 
1224
1227
  # process the path parameters
1225
1228
  # process the query parameters
1226
- if latest is not None:
1227
-
1228
- _query_params.append(('latest', latest))
1229
-
1230
- if sort_by is not None:
1231
-
1232
- _query_params.append(('sort_by', sort_by))
1233
-
1234
- if page_number is not None:
1235
-
1236
- _query_params.append(('page_number', page_number))
1237
-
1238
- if items_per_page is not None:
1239
-
1240
- _query_params.append(('items_per_page', items_per_page))
1241
-
1242
1229
  if id is not None:
1243
1230
 
1244
1231
  _query_params.append(('id', id))
@@ -1271,6 +1258,22 @@ class UsersApi:
1271
1258
 
1272
1259
  _query_params.append(('oidc_sub', oidc_sub))
1273
1260
 
1261
+ if sort_by is not None:
1262
+
1263
+ _query_params.append(('sort_by', sort_by))
1264
+
1265
+ if latest is not None:
1266
+
1267
+ _query_params.append(('latest', latest))
1268
+
1269
+ if page is not None:
1270
+
1271
+ _query_params.append(('page', page))
1272
+
1273
+ if size is not None:
1274
+
1275
+ _query_params.append(('size', size))
1276
+
1274
1277
  # process the header parameters
1275
1278
  # process the form parameters
1276
1279
  # process the body parameter
@@ -3,7 +3,7 @@
3
3
  """
4
4
  Quantum Inspire 2
5
5
 
6
- **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.
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
7
 
8
8
  The version of the OpenAPI document: 0.1.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -3,7 +3,7 @@
3
3
  """
4
4
  Quantum Inspire 2
5
5
 
6
- **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.
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
7
 
8
8
  The version of the OpenAPI document: 0.1.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -244,7 +244,7 @@ Name | Type | Description | Notes
244
244
  [[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)
245
245
 
246
246
  # **read_algorithms_algorithms_get**
247
- > List[Algorithm] read_algorithms_algorithms_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name)
247
+ > PageAlgorithm read_algorithms_algorithms_get(search=search, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
248
248
 
249
249
  List algorithms
250
250
 
@@ -257,8 +257,8 @@ List algorithms.
257
257
  import time
258
258
  import os
259
259
  import compute_api_client
260
- from compute_api_client.models.algorithm import Algorithm
261
260
  from compute_api_client.models.algorithm_type import AlgorithmType
261
+ from compute_api_client.models.page_algorithm import PageAlgorithm
262
262
  from compute_api_client.models.share_type import ShareType
263
263
  from compute_api_client.rest import ApiException
264
264
  from pprint import pprint
@@ -281,10 +281,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
281
281
  # Create an instance of the API class
282
282
  api_instance = compute_api_client.AlgorithmsApi(api_client)
283
283
  search = 'search_example' # str | Substring search for algorithm names (optional)
284
- latest = True # bool | (optional)
285
- sort_by = 'sort_by_example' # str | (optional)
286
- page_number = 56 # int | (optional)
287
- items_per_page = 56 # int | (optional)
288
284
  id = 56 # int | (optional)
289
285
  project_id = 56 # int | (optional)
290
286
  type = compute_api_client.AlgorithmType() # AlgorithmType | (optional)
@@ -292,10 +288,14 @@ async with compute_api_client.ApiClient(configuration) as api_client:
292
288
  link__isnull = True # bool | (optional)
293
289
  link = 'link_example' # str | (optional)
294
290
  name = 'name_example' # str | (optional)
291
+ sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
292
+ latest = True # bool | If True gets the most recently created object. (optional)
293
+ page = 1 # int | Page number (optional) (default to 1)
294
+ size = 50 # int | Page size (optional) (default to 50)
295
295
 
296
296
  try:
297
297
  # List algorithms
298
- api_response = await api_instance.read_algorithms_algorithms_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name)
298
+ api_response = await api_instance.read_algorithms_algorithms_get(search=search, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
299
299
  print("The response of AlgorithmsApi->read_algorithms_algorithms_get:\n")
300
300
  pprint(api_response)
301
301
  except Exception as e:
@@ -309,10 +309,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
309
309
  Name | Type | Description | Notes
310
310
  ------------- | ------------- | ------------- | -------------
311
311
  **search** | **str**| Substring search for algorithm names | [optional]
312
- **latest** | **bool**| | [optional]
313
- **sort_by** | **str**| | [optional]
314
- **page_number** | **int**| | [optional]
315
- **items_per_page** | **int**| | [optional]
316
312
  **id** | **int**| | [optional]
317
313
  **project_id** | **int**| | [optional]
318
314
  **type** | [**AlgorithmType**](.md)| | [optional]
@@ -320,10 +316,14 @@ Name | Type | Description | Notes
320
316
  **link__isnull** | **bool**| | [optional]
321
317
  **link** | **str**| | [optional]
322
318
  **name** | **str**| | [optional]
319
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional]
320
+ **latest** | **bool**| If True gets the most recently created object. | [optional]
321
+ **page** | **int**| Page number | [optional] [default to 1]
322
+ **size** | **int**| Page size | [optional] [default to 50]
323
323
 
324
324
  ### Return type
325
325
 
326
- [**List[Algorithm]**](Algorithm.md)
326
+ [**PageAlgorithm**](PageAlgorithm.md)
327
327
 
328
328
  ### Authorization
329
329
 
@@ -238,7 +238,7 @@ This endpoint does not need any parameter.
238
238
  [[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)
239
239
 
240
240
  # **read_backends_backends_get**
241
- > List[Backend] read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
241
+ > PageBackend read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size)
242
242
 
243
243
  List backends
244
244
 
@@ -251,8 +251,8 @@ Read backends.
251
251
  import time
252
252
  import os
253
253
  import compute_api_client
254
- from compute_api_client.models.backend import Backend
255
254
  from compute_api_client.models.backend_status import BackendStatus
255
+ from compute_api_client.models.page_backend import PageBackend
256
256
  from compute_api_client.rest import ApiException
257
257
  from pprint import pprint
258
258
 
@@ -273,20 +273,20 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
273
273
  async with compute_api_client.ApiClient(configuration) as api_client:
274
274
  # Create an instance of the API class
275
275
  api_instance = compute_api_client.BackendApi(api_client)
276
- latest = True # bool | (optional)
277
- sort_by = 'sort_by_example' # str | (optional)
278
- page_number = 56 # int | (optional)
279
- items_per_page = 56 # int | (optional)
280
276
  id = 56 # int | (optional)
281
277
  name = 'name_example' # str | (optional)
282
278
  location = 'location_example' # str | (optional)
283
279
  backend_type_id = 56 # int | (optional)
284
280
  status = compute_api_client.BackendStatus() # BackendStatus | (optional)
285
281
  last_heartbeat = '2013-10-20T19:20:30+01:00' # datetime | (optional)
282
+ sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
283
+ latest = True # bool | If True gets the most recently created object. (optional)
284
+ page = 1 # int | Page number (optional) (default to 1)
285
+ size = 50 # int | Page size (optional) (default to 50)
286
286
 
287
287
  try:
288
288
  # List backends
289
- api_response = await api_instance.read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
289
+ api_response = await api_instance.read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size)
290
290
  print("The response of BackendApi->read_backends_backends_get:\n")
291
291
  pprint(api_response)
292
292
  except Exception as e:
@@ -299,20 +299,20 @@ async with compute_api_client.ApiClient(configuration) as api_client:
299
299
 
300
300
  Name | Type | Description | Notes
301
301
  ------------- | ------------- | ------------- | -------------
302
- **latest** | **bool**| | [optional]
303
- **sort_by** | **str**| | [optional]
304
- **page_number** | **int**| | [optional]
305
- **items_per_page** | **int**| | [optional]
306
302
  **id** | **int**| | [optional]
307
303
  **name** | **str**| | [optional]
308
304
  **location** | **str**| | [optional]
309
305
  **backend_type_id** | **int**| | [optional]
310
306
  **status** | [**BackendStatus**](.md)| | [optional]
311
307
  **last_heartbeat** | **datetime**| | [optional]
308
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional]
309
+ **latest** | **bool**| If True gets the most recently created object. | [optional]
310
+ **page** | **int**| Page number | [optional] [default to 1]
311
+ **size** | **int**| Page size | [optional] [default to 50]
312
312
 
313
313
  ### Return type
314
314
 
315
- [**List[Backend]**](Backend.md)
315
+ [**PageBackend**](PageBackend.md)
316
316
 
317
317
  ### Authorization
318
318
 
@@ -12,7 +12,9 @@ Name | Type | Description | Notes
12
12
  **is_hardware** | **bool** | |
13
13
  **features** | **List[str]** | |
14
14
  **default_compiler_config** | **object** | |
15
- **native_gateset** | **object** | |
15
+ **gateset** | **List[str]** | |
16
+ **topology** | **List[List[int]]** | |
17
+ **nqubits** | **int** | |
16
18
  **status** | [**BackendStatus**](BackendStatus.md) | |
17
19
  **default_number_of_shots** | **int** | |
18
20
  **max_number_of_shots** | **int** | |
@@ -85,7 +85,7 @@ Name | Type | Description | Notes
85
85
  [[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)
86
86
 
87
87
  # **read_backend_types_backend_types_get**
88
- > List[BackendType] read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots)
88
+ > PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size)
89
89
 
90
90
  List backend types
91
91
 
@@ -99,7 +99,7 @@ import time
99
99
  import os
100
100
  import compute_api_client
101
101
  from compute_api_client.models.backend_status import BackendStatus
102
- from compute_api_client.models.backend_type import BackendType
102
+ from compute_api_client.models.page_backend_type import PageBackendType
103
103
  from compute_api_client.rest import ApiException
104
104
  from pprint import pprint
105
105
 
@@ -120,23 +120,24 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
120
120
  async with compute_api_client.ApiClient(configuration) as api_client:
121
121
  # Create an instance of the API class
122
122
  api_instance = compute_api_client.BackendTypesApi(api_client)
123
- latest = True # bool | (optional)
124
- sort_by = 'sort_by_example' # str | (optional)
125
- page_number = 56 # int | (optional)
126
- items_per_page = 56 # int | (optional)
127
123
  id = 56 # int | (optional)
128
124
  name = 'name_example' # str | (optional)
129
125
  infrastructure = 'infrastructure_example' # str | (optional)
130
126
  description = 'description_example' # str | (optional)
131
127
  image_id = 'image_id_example' # str | (optional)
132
128
  is_hardware = True # bool | (optional)
129
+ nqubits = 56 # int | (optional)
133
130
  status = compute_api_client.BackendStatus() # BackendStatus | (optional)
134
131
  default_number_of_shots = 56 # int | (optional)
135
132
  max_number_of_shots = 56 # int | (optional)
133
+ sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
134
+ latest = True # bool | If True gets the most recently created object. (optional)
135
+ page = 1 # int | Page number (optional) (default to 1)
136
+ size = 50 # int | Page size (optional) (default to 50)
136
137
 
137
138
  try:
138
139
  # List backend types
139
- api_response = await api_instance.read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots)
140
+ 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, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size)
140
141
  print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n")
141
142
  pprint(api_response)
142
143
  except Exception as e:
@@ -149,23 +150,24 @@ async with compute_api_client.ApiClient(configuration) as api_client:
149
150
 
150
151
  Name | Type | Description | Notes
151
152
  ------------- | ------------- | ------------- | -------------
152
- **latest** | **bool**| | [optional]
153
- **sort_by** | **str**| | [optional]
154
- **page_number** | **int**| | [optional]
155
- **items_per_page** | **int**| | [optional]
156
153
  **id** | **int**| | [optional]
157
154
  **name** | **str**| | [optional]
158
155
  **infrastructure** | **str**| | [optional]
159
156
  **description** | **str**| | [optional]
160
157
  **image_id** | **str**| | [optional]
161
158
  **is_hardware** | **bool**| | [optional]
159
+ **nqubits** | **int**| | [optional]
162
160
  **status** | [**BackendStatus**](.md)| | [optional]
163
161
  **default_number_of_shots** | **int**| | [optional]
164
162
  **max_number_of_shots** | **int**| | [optional]
163
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional]
164
+ **latest** | **bool**| If True gets the most recently created object. | [optional]
165
+ **page** | **int**| Page number | [optional] [default to 1]
166
+ **size** | **int**| Page size | [optional] [default to 50]
165
167
 
166
168
  ### Return type
167
169
 
168
- [**List[BackendType]**](BackendType.md)
170
+ [**PageBackendType**](PageBackendType.md)
169
171
 
170
172
  ### Authorization
171
173