qi-compute-api-client 0.21.0__py3-none-any.whl → 0.31.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.
- compute_api_client/__init__.py +1 -0
- compute_api_client/api/algorithms_api.py +25 -23
- compute_api_client/api/backend_api.py +19 -18
- compute_api_client/api/backend_types_api.py +54 -2
- compute_api_client/api/batch_jobs_api.py +5 -22
- compute_api_client/api/commits_api.py +5 -5
- compute_api_client/api/files_api.py +5 -5
- compute_api_client/api/final_results_api.py +4 -4
- compute_api_client/api/jobs_api.py +8 -8
- compute_api_client/api/languages_api.py +2 -2
- compute_api_client/api/members_api.py +4 -21
- compute_api_client/api/metadata_api.py +2 -2
- compute_api_client/api/permissions_api.py +4 -4
- compute_api_client/api/projects_api.py +28 -9
- compute_api_client/api/reservations_api.py +4 -4
- compute_api_client/api/results_api.py +566 -4
- compute_api_client/api/teams_api.py +2 -2
- compute_api_client/api/transactions_api.py +32 -32
- compute_api_client/api/users_api.py +21 -4
- compute_api_client/configuration.py +5 -7
- compute_api_client/docs/AlgorithmIn.md +1 -1
- compute_api_client/docs/AlgorithmsApi.md +20 -40
- compute_api_client/docs/BackendApi.md +14 -26
- compute_api_client/docs/BackendIn.md +32 -0
- compute_api_client/docs/BackendType.md +3 -0
- compute_api_client/docs/BackendTypesApi.md +15 -16
- compute_api_client/docs/BatchJobIn.md +0 -1
- compute_api_client/docs/BatchJobsApi.md +15 -33
- compute_api_client/docs/CommitsApi.md +13 -29
- compute_api_client/docs/FilesApi.md +13 -29
- compute_api_client/docs/FinalResultsApi.md +10 -22
- compute_api_client/docs/JobIn.md +0 -1
- compute_api_client/docs/JobsApi.md +18 -38
- compute_api_client/docs/LanguagesApi.md +6 -14
- compute_api_client/docs/MembersApi.md +14 -32
- compute_api_client/docs/MetadataApi.md +6 -14
- compute_api_client/docs/PermissionsApi.md +12 -28
- compute_api_client/docs/ProjectsApi.md +23 -45
- compute_api_client/docs/ReservationsApi.md +12 -28
- compute_api_client/docs/ResultsApi.md +115 -14
- compute_api_client/docs/TeamsApi.md +6 -14
- compute_api_client/docs/Transaction.md +1 -1
- compute_api_client/docs/TransactionsApi.md +12 -20
- compute_api_client/docs/User.md +1 -0
- compute_api_client/docs/UserIn.md +1 -0
- compute_api_client/docs/UsersApi.md +16 -30
- compute_api_client/models/__init__.py +1 -0
- compute_api_client/models/algorithm.py +1 -6
- compute_api_client/models/algorithm_in.py +1 -6
- compute_api_client/models/backend_in.py +98 -0
- compute_api_client/models/backend_type.py +9 -2
- compute_api_client/models/batch_job_in.py +1 -3
- compute_api_client/models/job_in.py +1 -4
- compute_api_client/models/transaction.py +6 -6
- compute_api_client/models/user.py +4 -2
- compute_api_client/models/user_in.py +4 -2
- {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/METADATA +12 -13
- {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/RECORD +60 -58
- {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/LICENSE.md +0 -0
- {qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/WHEEL +0 -0
|
@@ -297,7 +297,7 @@ class TransactionsApi:
|
|
|
297
297
|
|
|
298
298
|
# authentication setting
|
|
299
299
|
_auth_settings: List[str] = [
|
|
300
|
-
'
|
|
300
|
+
'user_bearer'
|
|
301
301
|
]
|
|
302
302
|
|
|
303
303
|
return self.api_client.param_serialize(
|
|
@@ -331,8 +331,8 @@ class TransactionsApi:
|
|
|
331
331
|
job__isnull: Optional[StrictBool] = None,
|
|
332
332
|
job: Optional[StrictInt] = None,
|
|
333
333
|
team_id: Optional[StrictInt] = None,
|
|
334
|
-
|
|
335
|
-
|
|
334
|
+
member_id__isnull: Optional[StrictBool] = None,
|
|
335
|
+
member_id: Optional[StrictInt] = None,
|
|
336
336
|
change: Optional[StrictInt] = None,
|
|
337
337
|
timestamp: Optional[datetime] = None,
|
|
338
338
|
_request_timeout: Union[
|
|
@@ -372,10 +372,10 @@ class TransactionsApi:
|
|
|
372
372
|
:type job: int
|
|
373
373
|
:param team_id:
|
|
374
374
|
:type team_id: int
|
|
375
|
-
:param
|
|
376
|
-
:type
|
|
377
|
-
:param
|
|
378
|
-
:type
|
|
375
|
+
:param member_id__isnull:
|
|
376
|
+
:type member_id__isnull: bool
|
|
377
|
+
:param member_id:
|
|
378
|
+
:type member_id: int
|
|
379
379
|
:param change:
|
|
380
380
|
:type change: int
|
|
381
381
|
:param timestamp:
|
|
@@ -413,8 +413,8 @@ class TransactionsApi:
|
|
|
413
413
|
job__isnull=job__isnull,
|
|
414
414
|
job=job,
|
|
415
415
|
team_id=team_id,
|
|
416
|
-
|
|
417
|
-
|
|
416
|
+
member_id__isnull=member_id__isnull,
|
|
417
|
+
member_id=member_id,
|
|
418
418
|
change=change,
|
|
419
419
|
timestamp=timestamp,
|
|
420
420
|
_request_auth=_request_auth,
|
|
@@ -452,8 +452,8 @@ class TransactionsApi:
|
|
|
452
452
|
job__isnull: Optional[StrictBool] = None,
|
|
453
453
|
job: Optional[StrictInt] = None,
|
|
454
454
|
team_id: Optional[StrictInt] = None,
|
|
455
|
-
|
|
456
|
-
|
|
455
|
+
member_id__isnull: Optional[StrictBool] = None,
|
|
456
|
+
member_id: Optional[StrictInt] = None,
|
|
457
457
|
change: Optional[StrictInt] = None,
|
|
458
458
|
timestamp: Optional[datetime] = None,
|
|
459
459
|
_request_timeout: Union[
|
|
@@ -493,10 +493,10 @@ class TransactionsApi:
|
|
|
493
493
|
:type job: int
|
|
494
494
|
:param team_id:
|
|
495
495
|
:type team_id: int
|
|
496
|
-
:param
|
|
497
|
-
:type
|
|
498
|
-
:param
|
|
499
|
-
:type
|
|
496
|
+
:param member_id__isnull:
|
|
497
|
+
:type member_id__isnull: bool
|
|
498
|
+
:param member_id:
|
|
499
|
+
:type member_id: int
|
|
500
500
|
:param change:
|
|
501
501
|
:type change: int
|
|
502
502
|
:param timestamp:
|
|
@@ -534,8 +534,8 @@ class TransactionsApi:
|
|
|
534
534
|
job__isnull=job__isnull,
|
|
535
535
|
job=job,
|
|
536
536
|
team_id=team_id,
|
|
537
|
-
|
|
538
|
-
|
|
537
|
+
member_id__isnull=member_id__isnull,
|
|
538
|
+
member_id=member_id,
|
|
539
539
|
change=change,
|
|
540
540
|
timestamp=timestamp,
|
|
541
541
|
_request_auth=_request_auth,
|
|
@@ -573,8 +573,8 @@ class TransactionsApi:
|
|
|
573
573
|
job__isnull: Optional[StrictBool] = None,
|
|
574
574
|
job: Optional[StrictInt] = None,
|
|
575
575
|
team_id: Optional[StrictInt] = None,
|
|
576
|
-
|
|
577
|
-
|
|
576
|
+
member_id__isnull: Optional[StrictBool] = None,
|
|
577
|
+
member_id: Optional[StrictInt] = None,
|
|
578
578
|
change: Optional[StrictInt] = None,
|
|
579
579
|
timestamp: Optional[datetime] = None,
|
|
580
580
|
_request_timeout: Union[
|
|
@@ -614,10 +614,10 @@ class TransactionsApi:
|
|
|
614
614
|
:type job: int
|
|
615
615
|
:param team_id:
|
|
616
616
|
:type team_id: int
|
|
617
|
-
:param
|
|
618
|
-
:type
|
|
619
|
-
:param
|
|
620
|
-
:type
|
|
617
|
+
:param member_id__isnull:
|
|
618
|
+
:type member_id__isnull: bool
|
|
619
|
+
:param member_id:
|
|
620
|
+
:type member_id: int
|
|
621
621
|
:param change:
|
|
622
622
|
:type change: int
|
|
623
623
|
:param timestamp:
|
|
@@ -655,8 +655,8 @@ class TransactionsApi:
|
|
|
655
655
|
job__isnull=job__isnull,
|
|
656
656
|
job=job,
|
|
657
657
|
team_id=team_id,
|
|
658
|
-
|
|
659
|
-
|
|
658
|
+
member_id__isnull=member_id__isnull,
|
|
659
|
+
member_id=member_id,
|
|
660
660
|
change=change,
|
|
661
661
|
timestamp=timestamp,
|
|
662
662
|
_request_auth=_request_auth,
|
|
@@ -689,8 +689,8 @@ class TransactionsApi:
|
|
|
689
689
|
job__isnull,
|
|
690
690
|
job,
|
|
691
691
|
team_id,
|
|
692
|
-
|
|
693
|
-
|
|
692
|
+
member_id__isnull,
|
|
693
|
+
member_id,
|
|
694
694
|
change,
|
|
695
695
|
timestamp,
|
|
696
696
|
_request_auth,
|
|
@@ -754,13 +754,13 @@ class TransactionsApi:
|
|
|
754
754
|
|
|
755
755
|
_query_params.append(('team_id', team_id))
|
|
756
756
|
|
|
757
|
-
if
|
|
757
|
+
if member_id__isnull is not None:
|
|
758
758
|
|
|
759
|
-
_query_params.append(('
|
|
759
|
+
_query_params.append(('member_id__isnull', member_id__isnull))
|
|
760
760
|
|
|
761
|
-
if
|
|
761
|
+
if member_id is not None:
|
|
762
762
|
|
|
763
|
-
_query_params.append(('
|
|
763
|
+
_query_params.append(('member_id', member_id))
|
|
764
764
|
|
|
765
765
|
if change is not None:
|
|
766
766
|
|
|
@@ -794,7 +794,7 @@ class TransactionsApi:
|
|
|
794
794
|
|
|
795
795
|
# authentication setting
|
|
796
796
|
_auth_settings: List[str] = [
|
|
797
|
-
'
|
|
797
|
+
'user_bearer'
|
|
798
798
|
]
|
|
799
799
|
|
|
800
800
|
return self.api_client.param_serialize(
|
|
@@ -305,7 +305,7 @@ class UsersApi:
|
|
|
305
305
|
|
|
306
306
|
# authentication setting
|
|
307
307
|
_auth_settings: List[str] = [
|
|
308
|
-
'
|
|
308
|
+
'user_bearer'
|
|
309
309
|
]
|
|
310
310
|
|
|
311
311
|
return self.api_client.param_serialize(
|
|
@@ -564,7 +564,7 @@ class UsersApi:
|
|
|
564
564
|
|
|
565
565
|
# authentication setting
|
|
566
566
|
_auth_settings: List[str] = [
|
|
567
|
-
'
|
|
567
|
+
'user_bearer'
|
|
568
568
|
]
|
|
569
569
|
|
|
570
570
|
return self.api_client.param_serialize(
|
|
@@ -832,7 +832,7 @@ class UsersApi:
|
|
|
832
832
|
|
|
833
833
|
# authentication setting
|
|
834
834
|
_auth_settings: List[str] = [
|
|
835
|
-
'
|
|
835
|
+
'user_bearer'
|
|
836
836
|
]
|
|
837
837
|
|
|
838
838
|
return self.api_client.param_serialize(
|
|
@@ -867,6 +867,7 @@ class UsersApi:
|
|
|
867
867
|
is_staff: Optional[StrictBool] = None,
|
|
868
868
|
is_active: Optional[StrictBool] = None,
|
|
869
869
|
is_confirmed: Optional[StrictBool] = None,
|
|
870
|
+
oidc_sub: Optional[StrictStr] = None,
|
|
870
871
|
_request_timeout: Union[
|
|
871
872
|
None,
|
|
872
873
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -906,6 +907,8 @@ class UsersApi:
|
|
|
906
907
|
:type is_active: bool
|
|
907
908
|
:param is_confirmed:
|
|
908
909
|
:type is_confirmed: bool
|
|
910
|
+
:param oidc_sub:
|
|
911
|
+
:type oidc_sub: str
|
|
909
912
|
:param _request_timeout: timeout setting for this request. If one
|
|
910
913
|
number provided, it will be total request
|
|
911
914
|
timeout. It can also be a pair (tuple) of
|
|
@@ -940,6 +943,7 @@ class UsersApi:
|
|
|
940
943
|
is_staff=is_staff,
|
|
941
944
|
is_active=is_active,
|
|
942
945
|
is_confirmed=is_confirmed,
|
|
946
|
+
oidc_sub=oidc_sub,
|
|
943
947
|
_request_auth=_request_auth,
|
|
944
948
|
_content_type=_content_type,
|
|
945
949
|
_headers=_headers,
|
|
@@ -976,6 +980,7 @@ class UsersApi:
|
|
|
976
980
|
is_staff: Optional[StrictBool] = None,
|
|
977
981
|
is_active: Optional[StrictBool] = None,
|
|
978
982
|
is_confirmed: Optional[StrictBool] = None,
|
|
983
|
+
oidc_sub: Optional[StrictStr] = None,
|
|
979
984
|
_request_timeout: Union[
|
|
980
985
|
None,
|
|
981
986
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1015,6 +1020,8 @@ class UsersApi:
|
|
|
1015
1020
|
:type is_active: bool
|
|
1016
1021
|
:param is_confirmed:
|
|
1017
1022
|
:type is_confirmed: bool
|
|
1023
|
+
:param oidc_sub:
|
|
1024
|
+
:type oidc_sub: str
|
|
1018
1025
|
:param _request_timeout: timeout setting for this request. If one
|
|
1019
1026
|
number provided, it will be total request
|
|
1020
1027
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1049,6 +1056,7 @@ class UsersApi:
|
|
|
1049
1056
|
is_staff=is_staff,
|
|
1050
1057
|
is_active=is_active,
|
|
1051
1058
|
is_confirmed=is_confirmed,
|
|
1059
|
+
oidc_sub=oidc_sub,
|
|
1052
1060
|
_request_auth=_request_auth,
|
|
1053
1061
|
_content_type=_content_type,
|
|
1054
1062
|
_headers=_headers,
|
|
@@ -1085,6 +1093,7 @@ class UsersApi:
|
|
|
1085
1093
|
is_staff: Optional[StrictBool] = None,
|
|
1086
1094
|
is_active: Optional[StrictBool] = None,
|
|
1087
1095
|
is_confirmed: Optional[StrictBool] = None,
|
|
1096
|
+
oidc_sub: Optional[StrictStr] = None,
|
|
1088
1097
|
_request_timeout: Union[
|
|
1089
1098
|
None,
|
|
1090
1099
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1124,6 +1133,8 @@ class UsersApi:
|
|
|
1124
1133
|
:type is_active: bool
|
|
1125
1134
|
:param is_confirmed:
|
|
1126
1135
|
:type is_confirmed: bool
|
|
1136
|
+
:param oidc_sub:
|
|
1137
|
+
:type oidc_sub: str
|
|
1127
1138
|
:param _request_timeout: timeout setting for this request. If one
|
|
1128
1139
|
number provided, it will be total request
|
|
1129
1140
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1158,6 +1169,7 @@ class UsersApi:
|
|
|
1158
1169
|
is_staff=is_staff,
|
|
1159
1170
|
is_active=is_active,
|
|
1160
1171
|
is_confirmed=is_confirmed,
|
|
1172
|
+
oidc_sub=oidc_sub,
|
|
1161
1173
|
_request_auth=_request_auth,
|
|
1162
1174
|
_content_type=_content_type,
|
|
1163
1175
|
_headers=_headers,
|
|
@@ -1189,6 +1201,7 @@ class UsersApi:
|
|
|
1189
1201
|
is_staff,
|
|
1190
1202
|
is_active,
|
|
1191
1203
|
is_confirmed,
|
|
1204
|
+
oidc_sub,
|
|
1192
1205
|
_request_auth,
|
|
1193
1206
|
_content_type,
|
|
1194
1207
|
_headers,
|
|
@@ -1254,6 +1267,10 @@ class UsersApi:
|
|
|
1254
1267
|
|
|
1255
1268
|
_query_params.append(('is_confirmed', is_confirmed))
|
|
1256
1269
|
|
|
1270
|
+
if oidc_sub is not None:
|
|
1271
|
+
|
|
1272
|
+
_query_params.append(('oidc_sub', oidc_sub))
|
|
1273
|
+
|
|
1257
1274
|
# process the header parameters
|
|
1258
1275
|
# process the form parameters
|
|
1259
1276
|
# process the body parameter
|
|
@@ -1269,7 +1286,7 @@ class UsersApi:
|
|
|
1269
1286
|
|
|
1270
1287
|
# authentication setting
|
|
1271
1288
|
_auth_settings: List[str] = [
|
|
1272
|
-
'
|
|
1289
|
+
'user_bearer'
|
|
1273
1290
|
]
|
|
1274
1291
|
|
|
1275
1292
|
return self.api_client.param_serialize(
|
|
@@ -373,14 +373,12 @@ conf = compute_api_client.Configuration(
|
|
|
373
373
|
:return: The Auth Settings information dict.
|
|
374
374
|
"""
|
|
375
375
|
auth = {}
|
|
376
|
-
if
|
|
377
|
-
auth['
|
|
378
|
-
'type': '
|
|
376
|
+
if self.access_token is not None:
|
|
377
|
+
auth['user_bearer'] = {
|
|
378
|
+
'type': 'oauth2',
|
|
379
379
|
'in': 'header',
|
|
380
|
-
'key': '
|
|
381
|
-
'value': self.
|
|
382
|
-
'user',
|
|
383
|
-
),
|
|
380
|
+
'key': 'Authorization',
|
|
381
|
+
'value': 'Bearer ' + self.access_token
|
|
384
382
|
}
|
|
385
383
|
if 'backend' in self.api_key:
|
|
386
384
|
auth['backend'] = {
|
|
@@ -20,7 +20,7 @@ Create new algorithm.
|
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
23
|
-
*
|
|
23
|
+
* OAuth Authentication (user_bearer):
|
|
24
24
|
```python
|
|
25
25
|
import time
|
|
26
26
|
import os
|
|
@@ -41,11 +41,7 @@ configuration = compute_api_client.Configuration(
|
|
|
41
41
|
# Examples for each auth method are provided below, use the example that
|
|
42
42
|
# satisfies your auth use case.
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
46
|
-
|
|
47
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
48
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
44
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
49
45
|
|
|
50
46
|
# Enter a context with an instance of the API client
|
|
51
47
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
@@ -76,7 +72,7 @@ Name | Type | Description | Notes
|
|
|
76
72
|
|
|
77
73
|
### Authorization
|
|
78
74
|
|
|
79
|
-
[
|
|
75
|
+
[user_bearer](../README.md#user_bearer)
|
|
80
76
|
|
|
81
77
|
### HTTP request headers
|
|
82
78
|
|
|
@@ -100,7 +96,7 @@ Delete an algorithm.
|
|
|
100
96
|
|
|
101
97
|
### Example
|
|
102
98
|
|
|
103
|
-
*
|
|
99
|
+
* OAuth Authentication (user_bearer):
|
|
104
100
|
```python
|
|
105
101
|
import time
|
|
106
102
|
import os
|
|
@@ -119,11 +115,7 @@ configuration = compute_api_client.Configuration(
|
|
|
119
115
|
# Examples for each auth method are provided below, use the example that
|
|
120
116
|
# satisfies your auth use case.
|
|
121
117
|
|
|
122
|
-
|
|
123
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
124
|
-
|
|
125
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
126
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
118
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
127
119
|
|
|
128
120
|
# Enter a context with an instance of the API client
|
|
129
121
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
@@ -152,7 +144,7 @@ void (empty response body)
|
|
|
152
144
|
|
|
153
145
|
### Authorization
|
|
154
146
|
|
|
155
|
-
[
|
|
147
|
+
[user_bearer](../README.md#user_bearer)
|
|
156
148
|
|
|
157
149
|
### HTTP request headers
|
|
158
150
|
|
|
@@ -177,8 +169,8 @@ Get algorithm by ID.
|
|
|
177
169
|
|
|
178
170
|
### Example
|
|
179
171
|
|
|
172
|
+
* OAuth Authentication (user_bearer):
|
|
180
173
|
* Api Key Authentication (backend):
|
|
181
|
-
* Api Key Authentication (user):
|
|
182
174
|
```python
|
|
183
175
|
import time
|
|
184
176
|
import os
|
|
@@ -198,18 +190,14 @@ configuration = compute_api_client.Configuration(
|
|
|
198
190
|
# Examples for each auth method are provided below, use the example that
|
|
199
191
|
# satisfies your auth use case.
|
|
200
192
|
|
|
193
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
194
|
+
|
|
201
195
|
# Configure API key authorization: backend
|
|
202
196
|
configuration.api_key['backend'] = os.environ["API_KEY"]
|
|
203
197
|
|
|
204
198
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
205
199
|
# configuration.api_key_prefix['backend'] = 'Bearer'
|
|
206
200
|
|
|
207
|
-
# Configure API key authorization: user
|
|
208
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
209
|
-
|
|
210
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
211
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
212
|
-
|
|
213
201
|
# Enter a context with an instance of the API client
|
|
214
202
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
215
203
|
# Create an instance of the API class
|
|
@@ -239,7 +227,7 @@ Name | Type | Description | Notes
|
|
|
239
227
|
|
|
240
228
|
### Authorization
|
|
241
229
|
|
|
242
|
-
[
|
|
230
|
+
[user_bearer](../README.md#user_bearer), [backend](../README.md#backend)
|
|
243
231
|
|
|
244
232
|
### HTTP request headers
|
|
245
233
|
|
|
@@ -256,7 +244,7 @@ Name | Type | Description | Notes
|
|
|
256
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)
|
|
257
245
|
|
|
258
246
|
# **read_algorithms_algorithms_get**
|
|
259
|
-
> List[Algorithm] read_algorithms_algorithms_get(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,
|
|
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)
|
|
260
248
|
|
|
261
249
|
List algorithms
|
|
262
250
|
|
|
@@ -264,7 +252,7 @@ List algorithms.
|
|
|
264
252
|
|
|
265
253
|
### Example
|
|
266
254
|
|
|
267
|
-
*
|
|
255
|
+
* OAuth Authentication (user_bearer):
|
|
268
256
|
```python
|
|
269
257
|
import time
|
|
270
258
|
import os
|
|
@@ -286,16 +274,13 @@ configuration = compute_api_client.Configuration(
|
|
|
286
274
|
# Examples for each auth method are provided below, use the example that
|
|
287
275
|
# satisfies your auth use case.
|
|
288
276
|
|
|
289
|
-
|
|
290
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
291
|
-
|
|
292
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
293
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
277
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
294
278
|
|
|
295
279
|
# Enter a context with an instance of the API client
|
|
296
280
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
297
281
|
# Create an instance of the API class
|
|
298
282
|
api_instance = compute_api_client.AlgorithmsApi(api_client)
|
|
283
|
+
search = 'search_example' # str | Substring search for algorithm names (optional)
|
|
299
284
|
latest = True # bool | (optional)
|
|
300
285
|
sort_by = 'sort_by_example' # str | (optional)
|
|
301
286
|
page_number = 56 # int | (optional)
|
|
@@ -306,12 +291,11 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
306
291
|
shared = compute_api_client.ShareType() # ShareType | (optional)
|
|
307
292
|
link__isnull = True # bool | (optional)
|
|
308
293
|
link = 'link_example' # str | (optional)
|
|
309
|
-
name__isnull = True # bool | (optional)
|
|
310
294
|
name = 'name_example' # str | (optional)
|
|
311
295
|
|
|
312
296
|
try:
|
|
313
297
|
# List algorithms
|
|
314
|
-
api_response = await api_instance.read_algorithms_algorithms_get(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,
|
|
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)
|
|
315
299
|
print("The response of AlgorithmsApi->read_algorithms_algorithms_get:\n")
|
|
316
300
|
pprint(api_response)
|
|
317
301
|
except Exception as e:
|
|
@@ -324,6 +308,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
324
308
|
|
|
325
309
|
Name | Type | Description | Notes
|
|
326
310
|
------------- | ------------- | ------------- | -------------
|
|
311
|
+
**search** | **str**| Substring search for algorithm names | [optional]
|
|
327
312
|
**latest** | **bool**| | [optional]
|
|
328
313
|
**sort_by** | **str**| | [optional]
|
|
329
314
|
**page_number** | **int**| | [optional]
|
|
@@ -334,7 +319,6 @@ Name | Type | Description | Notes
|
|
|
334
319
|
**shared** | [**ShareType**](.md)| | [optional]
|
|
335
320
|
**link__isnull** | **bool**| | [optional]
|
|
336
321
|
**link** | **str**| | [optional]
|
|
337
|
-
**name__isnull** | **bool**| | [optional]
|
|
338
322
|
**name** | **str**| | [optional]
|
|
339
323
|
|
|
340
324
|
### Return type
|
|
@@ -343,7 +327,7 @@ Name | Type | Description | Notes
|
|
|
343
327
|
|
|
344
328
|
### Authorization
|
|
345
329
|
|
|
346
|
-
[
|
|
330
|
+
[user_bearer](../README.md#user_bearer)
|
|
347
331
|
|
|
348
332
|
### HTTP request headers
|
|
349
333
|
|
|
@@ -367,7 +351,7 @@ Update an algorithm.
|
|
|
367
351
|
|
|
368
352
|
### Example
|
|
369
353
|
|
|
370
|
-
*
|
|
354
|
+
* OAuth Authentication (user_bearer):
|
|
371
355
|
```python
|
|
372
356
|
import time
|
|
373
357
|
import os
|
|
@@ -388,11 +372,7 @@ configuration = compute_api_client.Configuration(
|
|
|
388
372
|
# Examples for each auth method are provided below, use the example that
|
|
389
373
|
# satisfies your auth use case.
|
|
390
374
|
|
|
391
|
-
|
|
392
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
393
|
-
|
|
394
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
395
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
375
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
396
376
|
|
|
397
377
|
# Enter a context with an instance of the API client
|
|
398
378
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
@@ -425,7 +405,7 @@ Name | Type | Description | Notes
|
|
|
425
405
|
|
|
426
406
|
### Authorization
|
|
427
407
|
|
|
428
|
-
[
|
|
408
|
+
[user_bearer](../README.md#user_bearer)
|
|
429
409
|
|
|
430
410
|
### HTTP request headers
|
|
431
411
|
|
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
# **create_backend_backends_post**
|
|
15
|
-
> BackendWithAuthentication create_backend_backends_post(
|
|
15
|
+
> BackendWithAuthentication create_backend_backends_post(backend_in)
|
|
16
16
|
|
|
17
17
|
Create backend
|
|
18
18
|
|
|
@@ -20,12 +20,12 @@ Create new backend.
|
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
23
|
-
*
|
|
23
|
+
* OAuth Authentication (user_bearer):
|
|
24
24
|
```python
|
|
25
25
|
import time
|
|
26
26
|
import os
|
|
27
27
|
import compute_api_client
|
|
28
|
-
from compute_api_client.models.
|
|
28
|
+
from compute_api_client.models.backend_in import BackendIn
|
|
29
29
|
from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
|
|
30
30
|
from compute_api_client.rest import ApiException
|
|
31
31
|
from pprint import pprint
|
|
@@ -41,21 +41,17 @@ configuration = compute_api_client.Configuration(
|
|
|
41
41
|
# Examples for each auth method are provided below, use the example that
|
|
42
42
|
# satisfies your auth use case.
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
46
|
-
|
|
47
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
48
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
44
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
49
45
|
|
|
50
46
|
# Enter a context with an instance of the API client
|
|
51
47
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
52
48
|
# Create an instance of the API class
|
|
53
49
|
api_instance = compute_api_client.BackendApi(api_client)
|
|
54
|
-
|
|
50
|
+
backend_in = compute_api_client.BackendIn() # BackendIn |
|
|
55
51
|
|
|
56
52
|
try:
|
|
57
53
|
# Create backend
|
|
58
|
-
api_response = await api_instance.create_backend_backends_post(
|
|
54
|
+
api_response = await api_instance.create_backend_backends_post(backend_in)
|
|
59
55
|
print("The response of BackendApi->create_backend_backends_post:\n")
|
|
60
56
|
pprint(api_response)
|
|
61
57
|
except Exception as e:
|
|
@@ -68,7 +64,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
68
64
|
|
|
69
65
|
Name | Type | Description | Notes
|
|
70
66
|
------------- | ------------- | ------------- | -------------
|
|
71
|
-
**
|
|
67
|
+
**backend_in** | [**BackendIn**](BackendIn.md)| |
|
|
72
68
|
|
|
73
69
|
### Return type
|
|
74
70
|
|
|
@@ -76,7 +72,7 @@ Name | Type | Description | Notes
|
|
|
76
72
|
|
|
77
73
|
### Authorization
|
|
78
74
|
|
|
79
|
-
[
|
|
75
|
+
[user_bearer](../README.md#user_bearer)
|
|
80
76
|
|
|
81
77
|
### HTTP request headers
|
|
82
78
|
|
|
@@ -100,7 +96,7 @@ Get backend by ID.
|
|
|
100
96
|
|
|
101
97
|
### Example
|
|
102
98
|
|
|
103
|
-
*
|
|
99
|
+
* OAuth Authentication (user_bearer):
|
|
104
100
|
```python
|
|
105
101
|
import time
|
|
106
102
|
import os
|
|
@@ -120,11 +116,7 @@ configuration = compute_api_client.Configuration(
|
|
|
120
116
|
# Examples for each auth method are provided below, use the example that
|
|
121
117
|
# satisfies your auth use case.
|
|
122
118
|
|
|
123
|
-
|
|
124
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
125
|
-
|
|
126
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
127
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
119
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
128
120
|
|
|
129
121
|
# Enter a context with an instance of the API client
|
|
130
122
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
@@ -155,7 +147,7 @@ Name | Type | Description | Notes
|
|
|
155
147
|
|
|
156
148
|
### Authorization
|
|
157
149
|
|
|
158
|
-
[
|
|
150
|
+
[user_bearer](../README.md#user_bearer)
|
|
159
151
|
|
|
160
152
|
### HTTP request headers
|
|
161
153
|
|
|
@@ -254,7 +246,7 @@ Read backends.
|
|
|
254
246
|
|
|
255
247
|
### Example
|
|
256
248
|
|
|
257
|
-
*
|
|
249
|
+
* OAuth Authentication (user_bearer):
|
|
258
250
|
```python
|
|
259
251
|
import time
|
|
260
252
|
import os
|
|
@@ -275,11 +267,7 @@ configuration = compute_api_client.Configuration(
|
|
|
275
267
|
# Examples for each auth method are provided below, use the example that
|
|
276
268
|
# satisfies your auth use case.
|
|
277
269
|
|
|
278
|
-
|
|
279
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
280
|
-
|
|
281
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
282
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
270
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
283
271
|
|
|
284
272
|
# Enter a context with an instance of the API client
|
|
285
273
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
@@ -328,7 +316,7 @@ Name | Type | Description | Notes
|
|
|
328
316
|
|
|
329
317
|
### Authorization
|
|
330
318
|
|
|
331
|
-
[
|
|
319
|
+
[user_bearer](../README.md#user_bearer)
|
|
332
320
|
|
|
333
321
|
### HTTP request headers
|
|
334
322
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# BackendIn
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **str** | |
|
|
8
|
+
**location** | **str** | |
|
|
9
|
+
**backend_type_id** | **int** | |
|
|
10
|
+
**status** | [**BackendStatus**](BackendStatus.md) | |
|
|
11
|
+
**last_heartbeat** | **datetime** | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```python
|
|
16
|
+
from compute_api_client.models.backend_in import BackendIn
|
|
17
|
+
|
|
18
|
+
# TODO update the JSON string below
|
|
19
|
+
json = "{}"
|
|
20
|
+
# create an instance of BackendIn from a JSON string
|
|
21
|
+
backend_in_instance = BackendIn.from_json(json)
|
|
22
|
+
# print the JSON string representation of the object
|
|
23
|
+
print BackendIn.to_json()
|
|
24
|
+
|
|
25
|
+
# convert the object into a dict
|
|
26
|
+
backend_in_dict = backend_in_instance.to_dict()
|
|
27
|
+
# create an instance of BackendIn from a dict
|
|
28
|
+
backend_in_form_dict = backend_in.from_dict(backend_in_dict)
|
|
29
|
+
```
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
31
|
+
|
|
32
|
+
|
|
@@ -13,6 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**features** | **List[str]** | |
|
|
14
14
|
**default_compiler_config** | **object** | |
|
|
15
15
|
**native_gateset** | **object** | |
|
|
16
|
+
**status** | [**BackendStatus**](BackendStatus.md) | |
|
|
17
|
+
**default_number_of_shots** | **int** | |
|
|
18
|
+
**max_number_of_shots** | **int** | |
|
|
16
19
|
|
|
17
20
|
## Example
|
|
18
21
|
|