qi-compute-api-client 0.17.0__py3-none-any.whl → 0.27.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 +2 -1
- compute_api_client/api/algorithms_api.py +110 -1
- compute_api_client/api/backend_api.py +71 -16
- compute_api_client/api/backend_types_api.py +106 -1
- compute_api_client/api/batch_jobs_api.py +310 -5
- compute_api_client/api/commits_api.py +56 -1
- compute_api_client/api/files_api.py +56 -1
- compute_api_client/api/final_results_api.py +4 -1
- compute_api_client/api/jobs_api.py +60 -2
- compute_api_client/api/languages_api.py +54 -1
- compute_api_client/api/members_api.py +57 -2
- compute_api_client/api/metadata_api.py +3 -1
- compute_api_client/api/permissions_api.py +107 -1
- compute_api_client/api/projects_api.py +80 -4
- compute_api_client/api/reservations_api.py +57 -2
- compute_api_client/api/results_api.py +268 -7
- compute_api_client/api/teams_api.py +54 -1
- compute_api_client/api/transactions_api.py +55 -2
- compute_api_client/api/users_api.py +73 -1
- compute_api_client/api_client.py +1 -1
- compute_api_client/configuration.py +8 -1
- compute_api_client/docs/Algorithm.md +1 -0
- compute_api_client/docs/AlgorithmIn.md +1 -0
- compute_api_client/docs/AlgorithmsApi.md +34 -7
- compute_api_client/docs/BackendApi.md +25 -10
- compute_api_client/docs/BackendIn.md +32 -0
- compute_api_client/docs/BackendType.md +3 -0
- compute_api_client/docs/BackendTypesApi.md +23 -4
- compute_api_client/docs/BatchJobIn.md +0 -1
- compute_api_client/docs/BatchJobsApi.md +101 -7
- compute_api_client/docs/CommitIn.md +0 -1
- compute_api_client/docs/CommitsApi.md +24 -6
- compute_api_client/docs/FilesApi.md +24 -6
- compute_api_client/docs/FinalResultsApi.md +12 -3
- compute_api_client/docs/JobIn.md +0 -1
- compute_api_client/docs/JobsApi.md +42 -7
- compute_api_client/docs/LanguagesApi.md +16 -4
- compute_api_client/docs/MembersApi.md +24 -6
- compute_api_client/docs/MetadataApi.md +8 -2
- compute_api_client/docs/PermissionsApi.md +32 -8
- compute_api_client/docs/ProjectsApi.md +35 -9
- compute_api_client/docs/ReservationsApi.md +24 -6
- compute_api_client/docs/ResultsApi.md +90 -6
- compute_api_client/docs/TeamsApi.md +16 -4
- compute_api_client/docs/TransactionsApi.md +16 -4
- compute_api_client/docs/User.md +1 -0
- compute_api_client/docs/UserIn.md +1 -0
- compute_api_client/docs/UsersApi.md +26 -6
- compute_api_client/exceptions.py +1 -1
- compute_api_client/models/__init__.py +2 -1
- compute_api_client/models/algorithm.py +10 -3
- compute_api_client/models/algorithm_in.py +10 -3
- compute_api_client/models/algorithm_type.py +1 -1
- compute_api_client/models/backend.py +1 -1
- compute_api_client/models/backend_in.py +98 -0
- compute_api_client/models/backend_patch.py +1 -1
- compute_api_client/models/backend_status.py +1 -1
- compute_api_client/models/backend_type.py +10 -3
- compute_api_client/models/backend_with_authentication.py +1 -1
- compute_api_client/models/batch_job.py +1 -1
- compute_api_client/models/batch_job_in.py +2 -4
- compute_api_client/models/batch_job_status.py +1 -1
- compute_api_client/models/commit.py +1 -1
- compute_api_client/models/commit_in.py +2 -6
- compute_api_client/models/compile_stage.py +1 -1
- compute_api_client/models/domain.py +1 -1
- compute_api_client/models/file.py +1 -1
- compute_api_client/models/file_in.py +1 -1
- compute_api_client/models/final_result.py +1 -1
- compute_api_client/models/final_result_in.py +1 -1
- compute_api_client/models/http_not_found_error.py +1 -1
- compute_api_client/models/http_validation_error.py +1 -1
- compute_api_client/models/job.py +1 -1
- compute_api_client/models/job_in.py +2 -5
- compute_api_client/models/job_patch.py +1 -1
- compute_api_client/models/job_status.py +1 -1
- compute_api_client/models/language.py +1 -1
- compute_api_client/models/location_inner.py +1 -1
- compute_api_client/models/member.py +1 -1
- compute_api_client/models/member_in.py +1 -1
- compute_api_client/models/metadata.py +1 -1
- compute_api_client/models/metadata_in.py +1 -1
- compute_api_client/models/permission.py +1 -1
- compute_api_client/models/permission_group.py +1 -1
- compute_api_client/models/project.py +1 -1
- compute_api_client/models/project_in.py +1 -1
- compute_api_client/models/project_patch.py +1 -1
- compute_api_client/models/reservation.py +1 -1
- compute_api_client/models/reservation_in.py +1 -1
- compute_api_client/models/result.py +1 -1
- compute_api_client/models/result_in.py +1 -1
- compute_api_client/models/role.py +1 -1
- compute_api_client/models/share_type.py +1 -1
- compute_api_client/models/team.py +1 -1
- compute_api_client/models/transaction.py +1 -1
- compute_api_client/models/user.py +5 -3
- compute_api_client/models/user_in.py +5 -3
- compute_api_client/models/validation_error.py +1 -1
- compute_api_client/rest.py +1 -1
- {qi_compute_api_client-0.17.0.dist-info → qi_compute_api_client-0.27.0.dist-info}/METADATA +17 -5
- qi_compute_api_client-0.27.0.dist-info/RECORD +144 -0
- qi_compute_api_client-0.17.0.dist-info/RECORD +0 -142
- {qi_compute_api_client-0.17.0.dist-info → qi_compute_api_client-0.27.0.dist-info}/LICENSE.md +0 -0
- {qi_compute_api_client-0.17.0.dist-info → qi_compute_api_client-0.27.0.dist-info}/WHEEL +0 -0
|
@@ -19,6 +19,7 @@ Get permission group by ID.
|
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
22
|
+
* OAuth Authentication (user_bearer):
|
|
22
23
|
* Api Key Authentication (user):
|
|
23
24
|
```python
|
|
24
25
|
import time
|
|
@@ -39,6 +40,8 @@ configuration = compute_api_client.Configuration(
|
|
|
39
40
|
# Examples for each auth method are provided below, use the example that
|
|
40
41
|
# satisfies your auth use case.
|
|
41
42
|
|
|
43
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
44
|
+
|
|
42
45
|
# Configure API key authorization: user
|
|
43
46
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
44
47
|
|
|
@@ -74,7 +77,7 @@ Name | Type | Description | Notes
|
|
|
74
77
|
|
|
75
78
|
### Authorization
|
|
76
79
|
|
|
77
|
-
[user](../README.md#user)
|
|
80
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
78
81
|
|
|
79
82
|
### HTTP request headers
|
|
80
83
|
|
|
@@ -91,7 +94,7 @@ Name | Type | Description | Notes
|
|
|
91
94
|
[[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)
|
|
92
95
|
|
|
93
96
|
# **read_permission_groups_permission_groups_get**
|
|
94
|
-
> List[PermissionGroup] read_permission_groups_permission_groups_get(latest=latest, id=id, name=name)
|
|
97
|
+
> List[PermissionGroup] read_permission_groups_permission_groups_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name)
|
|
95
98
|
|
|
96
99
|
List permission groups
|
|
97
100
|
|
|
@@ -99,6 +102,7 @@ Read permissions groups.
|
|
|
99
102
|
|
|
100
103
|
### Example
|
|
101
104
|
|
|
105
|
+
* OAuth Authentication (user_bearer):
|
|
102
106
|
* Api Key Authentication (user):
|
|
103
107
|
```python
|
|
104
108
|
import time
|
|
@@ -119,6 +123,8 @@ configuration = compute_api_client.Configuration(
|
|
|
119
123
|
# Examples for each auth method are provided below, use the example that
|
|
120
124
|
# satisfies your auth use case.
|
|
121
125
|
|
|
126
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
127
|
+
|
|
122
128
|
# Configure API key authorization: user
|
|
123
129
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
124
130
|
|
|
@@ -130,12 +136,15 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
130
136
|
# Create an instance of the API class
|
|
131
137
|
api_instance = compute_api_client.PermissionsApi(api_client)
|
|
132
138
|
latest = True # bool | (optional)
|
|
139
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
140
|
+
page_number = 56 # int | (optional)
|
|
141
|
+
items_per_page = 56 # int | (optional)
|
|
133
142
|
id = 56 # int | (optional)
|
|
134
143
|
name = 'name_example' # str | (optional)
|
|
135
144
|
|
|
136
145
|
try:
|
|
137
146
|
# List permission groups
|
|
138
|
-
api_response = await api_instance.read_permission_groups_permission_groups_get(latest=latest, id=id, name=name)
|
|
147
|
+
api_response = await api_instance.read_permission_groups_permission_groups_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name)
|
|
139
148
|
print("The response of PermissionsApi->read_permission_groups_permission_groups_get:\n")
|
|
140
149
|
pprint(api_response)
|
|
141
150
|
except Exception as e:
|
|
@@ -149,6 +158,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
149
158
|
Name | Type | Description | Notes
|
|
150
159
|
------------- | ------------- | ------------- | -------------
|
|
151
160
|
**latest** | **bool**| | [optional]
|
|
161
|
+
**sort_by** | **str**| | [optional]
|
|
162
|
+
**page_number** | **int**| | [optional]
|
|
163
|
+
**items_per_page** | **int**| | [optional]
|
|
152
164
|
**id** | **int**| | [optional]
|
|
153
165
|
**name** | **str**| | [optional]
|
|
154
166
|
|
|
@@ -158,7 +170,7 @@ Name | Type | Description | Notes
|
|
|
158
170
|
|
|
159
171
|
### Authorization
|
|
160
172
|
|
|
161
|
-
[user](../README.md#user)
|
|
173
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
162
174
|
|
|
163
175
|
### HTTP request headers
|
|
164
176
|
|
|
@@ -182,6 +194,7 @@ Get permission by ID.
|
|
|
182
194
|
|
|
183
195
|
### Example
|
|
184
196
|
|
|
197
|
+
* OAuth Authentication (user_bearer):
|
|
185
198
|
* Api Key Authentication (user):
|
|
186
199
|
```python
|
|
187
200
|
import time
|
|
@@ -202,6 +215,8 @@ configuration = compute_api_client.Configuration(
|
|
|
202
215
|
# Examples for each auth method are provided below, use the example that
|
|
203
216
|
# satisfies your auth use case.
|
|
204
217
|
|
|
218
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
219
|
+
|
|
205
220
|
# Configure API key authorization: user
|
|
206
221
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
207
222
|
|
|
@@ -237,7 +252,7 @@ Name | Type | Description | Notes
|
|
|
237
252
|
|
|
238
253
|
### Authorization
|
|
239
254
|
|
|
240
|
-
[user](../README.md#user)
|
|
255
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
241
256
|
|
|
242
257
|
### HTTP request headers
|
|
243
258
|
|
|
@@ -254,7 +269,7 @@ Name | Type | Description | Notes
|
|
|
254
269
|
[[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)
|
|
255
270
|
|
|
256
271
|
# **read_permissions_permissions_get**
|
|
257
|
-
> List[Permission] read_permissions_permissions_get(latest=latest, id=id, permission=permission, name=name)
|
|
272
|
+
> List[Permission] read_permissions_permissions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, permission=permission, name=name)
|
|
258
273
|
|
|
259
274
|
List permissions
|
|
260
275
|
|
|
@@ -262,6 +277,7 @@ Read permissions.
|
|
|
262
277
|
|
|
263
278
|
### Example
|
|
264
279
|
|
|
280
|
+
* OAuth Authentication (user_bearer):
|
|
265
281
|
* Api Key Authentication (user):
|
|
266
282
|
```python
|
|
267
283
|
import time
|
|
@@ -282,6 +298,8 @@ configuration = compute_api_client.Configuration(
|
|
|
282
298
|
# Examples for each auth method are provided below, use the example that
|
|
283
299
|
# satisfies your auth use case.
|
|
284
300
|
|
|
301
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
302
|
+
|
|
285
303
|
# Configure API key authorization: user
|
|
286
304
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
287
305
|
|
|
@@ -293,13 +311,16 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
293
311
|
# Create an instance of the API class
|
|
294
312
|
api_instance = compute_api_client.PermissionsApi(api_client)
|
|
295
313
|
latest = True # bool | (optional)
|
|
314
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
315
|
+
page_number = 56 # int | (optional)
|
|
316
|
+
items_per_page = 56 # int | (optional)
|
|
296
317
|
id = 56 # int | (optional)
|
|
297
318
|
permission = 'permission_example' # str | (optional)
|
|
298
319
|
name = 'name_example' # str | (optional)
|
|
299
320
|
|
|
300
321
|
try:
|
|
301
322
|
# List permissions
|
|
302
|
-
api_response = await api_instance.read_permissions_permissions_get(latest=latest, id=id, permission=permission, name=name)
|
|
323
|
+
api_response = await api_instance.read_permissions_permissions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, permission=permission, name=name)
|
|
303
324
|
print("The response of PermissionsApi->read_permissions_permissions_get:\n")
|
|
304
325
|
pprint(api_response)
|
|
305
326
|
except Exception as e:
|
|
@@ -313,6 +334,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
313
334
|
Name | Type | Description | Notes
|
|
314
335
|
------------- | ------------- | ------------- | -------------
|
|
315
336
|
**latest** | **bool**| | [optional]
|
|
337
|
+
**sort_by** | **str**| | [optional]
|
|
338
|
+
**page_number** | **int**| | [optional]
|
|
339
|
+
**items_per_page** | **int**| | [optional]
|
|
316
340
|
**id** | **int**| | [optional]
|
|
317
341
|
**permission** | **str**| | [optional]
|
|
318
342
|
**name** | **str**| | [optional]
|
|
@@ -323,7 +347,7 @@ Name | Type | Description | Notes
|
|
|
323
347
|
|
|
324
348
|
### Authorization
|
|
325
349
|
|
|
326
|
-
[user](../README.md#user)
|
|
350
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
327
351
|
|
|
328
352
|
### HTTP request headers
|
|
329
353
|
|
|
@@ -21,6 +21,7 @@ Create new project.
|
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
24
|
+
* OAuth Authentication (user_bearer):
|
|
24
25
|
* Api Key Authentication (user):
|
|
25
26
|
```python
|
|
26
27
|
import time
|
|
@@ -42,6 +43,8 @@ configuration = compute_api_client.Configuration(
|
|
|
42
43
|
# Examples for each auth method are provided below, use the example that
|
|
43
44
|
# satisfies your auth use case.
|
|
44
45
|
|
|
46
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
47
|
+
|
|
45
48
|
# Configure API key authorization: user
|
|
46
49
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
47
50
|
|
|
@@ -77,7 +80,7 @@ Name | Type | Description | Notes
|
|
|
77
80
|
|
|
78
81
|
### Authorization
|
|
79
82
|
|
|
80
|
-
[user](../README.md#user)
|
|
83
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
81
84
|
|
|
82
85
|
### HTTP request headers
|
|
83
86
|
|
|
@@ -101,6 +104,7 @@ Delete a project.
|
|
|
101
104
|
|
|
102
105
|
### Example
|
|
103
106
|
|
|
107
|
+
* OAuth Authentication (user_bearer):
|
|
104
108
|
* Api Key Authentication (user):
|
|
105
109
|
```python
|
|
106
110
|
import time
|
|
@@ -120,6 +124,8 @@ configuration = compute_api_client.Configuration(
|
|
|
120
124
|
# Examples for each auth method are provided below, use the example that
|
|
121
125
|
# satisfies your auth use case.
|
|
122
126
|
|
|
127
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
128
|
+
|
|
123
129
|
# Configure API key authorization: user
|
|
124
130
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
125
131
|
|
|
@@ -153,7 +159,7 @@ void (empty response body)
|
|
|
153
159
|
|
|
154
160
|
### Authorization
|
|
155
161
|
|
|
156
|
-
[user](../README.md#user)
|
|
162
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
157
163
|
|
|
158
164
|
### HTTP request headers
|
|
159
165
|
|
|
@@ -178,6 +184,7 @@ Partially update a project.
|
|
|
178
184
|
|
|
179
185
|
### Example
|
|
180
186
|
|
|
187
|
+
* OAuth Authentication (user_bearer):
|
|
181
188
|
* Api Key Authentication (user):
|
|
182
189
|
```python
|
|
183
190
|
import time
|
|
@@ -199,6 +206,8 @@ configuration = compute_api_client.Configuration(
|
|
|
199
206
|
# Examples for each auth method are provided below, use the example that
|
|
200
207
|
# satisfies your auth use case.
|
|
201
208
|
|
|
209
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
210
|
+
|
|
202
211
|
# Configure API key authorization: user
|
|
203
212
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
204
213
|
|
|
@@ -236,7 +245,7 @@ Name | Type | Description | Notes
|
|
|
236
245
|
|
|
237
246
|
### Authorization
|
|
238
247
|
|
|
239
|
-
[user](../README.md#user)
|
|
248
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
240
249
|
|
|
241
250
|
### HTTP request headers
|
|
242
251
|
|
|
@@ -261,6 +270,7 @@ Get project by ID.
|
|
|
261
270
|
|
|
262
271
|
### Example
|
|
263
272
|
|
|
273
|
+
* OAuth Authentication (user_bearer):
|
|
264
274
|
* Api Key Authentication (user):
|
|
265
275
|
```python
|
|
266
276
|
import time
|
|
@@ -281,6 +291,8 @@ configuration = compute_api_client.Configuration(
|
|
|
281
291
|
# Examples for each auth method are provided below, use the example that
|
|
282
292
|
# satisfies your auth use case.
|
|
283
293
|
|
|
294
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
295
|
+
|
|
284
296
|
# Configure API key authorization: user
|
|
285
297
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
286
298
|
|
|
@@ -316,7 +328,7 @@ Name | Type | Description | Notes
|
|
|
316
328
|
|
|
317
329
|
### Authorization
|
|
318
330
|
|
|
319
|
-
[user](../README.md#user)
|
|
331
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
320
332
|
|
|
321
333
|
### HTTP request headers
|
|
322
334
|
|
|
@@ -333,14 +345,15 @@ Name | Type | Description | Notes
|
|
|
333
345
|
[[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)
|
|
334
346
|
|
|
335
347
|
# **read_projects_projects_get**
|
|
336
|
-
> List[Project] read_projects_projects_get(latest=latest, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
|
|
348
|
+
> List[Project] read_projects_projects_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
|
|
337
349
|
|
|
338
350
|
List projects
|
|
339
351
|
|
|
340
|
-
List projects.
|
|
352
|
+
List projects. If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
|
|
341
353
|
|
|
342
354
|
### Example
|
|
343
355
|
|
|
356
|
+
* OAuth Authentication (user_bearer):
|
|
344
357
|
* Api Key Authentication (user):
|
|
345
358
|
```python
|
|
346
359
|
import time
|
|
@@ -361,6 +374,8 @@ configuration = compute_api_client.Configuration(
|
|
|
361
374
|
# Examples for each auth method are provided below, use the example that
|
|
362
375
|
# satisfies your auth use case.
|
|
363
376
|
|
|
377
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
378
|
+
|
|
364
379
|
# Configure API key authorization: user
|
|
365
380
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
366
381
|
|
|
@@ -371,7 +386,11 @@ configuration.api_key['user'] = os.environ["API_KEY"]
|
|
|
371
386
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
372
387
|
# Create an instance of the API class
|
|
373
388
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
389
|
+
search = 'search_example' # str | Substring search for project names or description (optional)
|
|
374
390
|
latest = True # bool | (optional)
|
|
391
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
392
|
+
page_number = 56 # int | (optional)
|
|
393
|
+
items_per_page = 56 # int | (optional)
|
|
375
394
|
id = 56 # int | (optional)
|
|
376
395
|
created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
377
396
|
owner_id = 56 # int | (optional)
|
|
@@ -381,7 +400,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
381
400
|
|
|
382
401
|
try:
|
|
383
402
|
# List projects
|
|
384
|
-
api_response = await api_instance.read_projects_projects_get(latest=latest, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
|
|
403
|
+
api_response = await api_instance.read_projects_projects_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred)
|
|
385
404
|
print("The response of ProjectsApi->read_projects_projects_get:\n")
|
|
386
405
|
pprint(api_response)
|
|
387
406
|
except Exception as e:
|
|
@@ -394,7 +413,11 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
394
413
|
|
|
395
414
|
Name | Type | Description | Notes
|
|
396
415
|
------------- | ------------- | ------------- | -------------
|
|
416
|
+
**search** | **str**| Substring search for project names or description | [optional]
|
|
397
417
|
**latest** | **bool**| | [optional]
|
|
418
|
+
**sort_by** | **str**| | [optional]
|
|
419
|
+
**page_number** | **int**| | [optional]
|
|
420
|
+
**items_per_page** | **int**| | [optional]
|
|
398
421
|
**id** | **int**| | [optional]
|
|
399
422
|
**created_on** | **datetime**| | [optional]
|
|
400
423
|
**owner_id** | **int**| | [optional]
|
|
@@ -408,7 +431,7 @@ Name | Type | Description | Notes
|
|
|
408
431
|
|
|
409
432
|
### Authorization
|
|
410
433
|
|
|
411
|
-
[user](../README.md#user)
|
|
434
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
412
435
|
|
|
413
436
|
### HTTP request headers
|
|
414
437
|
|
|
@@ -432,6 +455,7 @@ Update a project.
|
|
|
432
455
|
|
|
433
456
|
### Example
|
|
434
457
|
|
|
458
|
+
* OAuth Authentication (user_bearer):
|
|
435
459
|
* Api Key Authentication (user):
|
|
436
460
|
```python
|
|
437
461
|
import time
|
|
@@ -453,6 +477,8 @@ configuration = compute_api_client.Configuration(
|
|
|
453
477
|
# Examples for each auth method are provided below, use the example that
|
|
454
478
|
# satisfies your auth use case.
|
|
455
479
|
|
|
480
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
481
|
+
|
|
456
482
|
# Configure API key authorization: user
|
|
457
483
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
458
484
|
|
|
@@ -490,7 +516,7 @@ Name | Type | Description | Notes
|
|
|
490
516
|
|
|
491
517
|
### Authorization
|
|
492
518
|
|
|
493
|
-
[user](../README.md#user)
|
|
519
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
494
520
|
|
|
495
521
|
### HTTP request headers
|
|
496
522
|
|
|
@@ -19,6 +19,7 @@ Create new reservation.
|
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
22
|
+
* OAuth Authentication (user_bearer):
|
|
22
23
|
* Api Key Authentication (user):
|
|
23
24
|
```python
|
|
24
25
|
import time
|
|
@@ -40,6 +41,8 @@ configuration = compute_api_client.Configuration(
|
|
|
40
41
|
# Examples for each auth method are provided below, use the example that
|
|
41
42
|
# satisfies your auth use case.
|
|
42
43
|
|
|
44
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
45
|
+
|
|
43
46
|
# Configure API key authorization: user
|
|
44
47
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
45
48
|
|
|
@@ -75,7 +78,7 @@ Name | Type | Description | Notes
|
|
|
75
78
|
|
|
76
79
|
### Authorization
|
|
77
80
|
|
|
78
|
-
[user](../README.md#user)
|
|
81
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
79
82
|
|
|
80
83
|
### HTTP request headers
|
|
81
84
|
|
|
@@ -99,6 +102,7 @@ Get reservation by ID.
|
|
|
99
102
|
|
|
100
103
|
### Example
|
|
101
104
|
|
|
105
|
+
* OAuth Authentication (user_bearer):
|
|
102
106
|
* Api Key Authentication (user):
|
|
103
107
|
```python
|
|
104
108
|
import time
|
|
@@ -119,6 +123,8 @@ configuration = compute_api_client.Configuration(
|
|
|
119
123
|
# Examples for each auth method are provided below, use the example that
|
|
120
124
|
# satisfies your auth use case.
|
|
121
125
|
|
|
126
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
127
|
+
|
|
122
128
|
# Configure API key authorization: user
|
|
123
129
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
124
130
|
|
|
@@ -154,7 +160,7 @@ Name | Type | Description | Notes
|
|
|
154
160
|
|
|
155
161
|
### Authorization
|
|
156
162
|
|
|
157
|
-
[user](../README.md#user)
|
|
163
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
158
164
|
|
|
159
165
|
### HTTP request headers
|
|
160
166
|
|
|
@@ -171,7 +177,7 @@ Name | Type | Description | Notes
|
|
|
171
177
|
[[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)
|
|
172
178
|
|
|
173
179
|
# **read_reservations_reservations_get**
|
|
174
|
-
> List[Reservation] read_reservations_reservations_get(latest=latest, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated)
|
|
180
|
+
> List[Reservation] read_reservations_reservations_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated)
|
|
175
181
|
|
|
176
182
|
List reservations
|
|
177
183
|
|
|
@@ -179,6 +185,7 @@ Read reservations.
|
|
|
179
185
|
|
|
180
186
|
### Example
|
|
181
187
|
|
|
188
|
+
* OAuth Authentication (user_bearer):
|
|
182
189
|
* Api Key Authentication (user):
|
|
183
190
|
```python
|
|
184
191
|
import time
|
|
@@ -199,6 +206,8 @@ configuration = compute_api_client.Configuration(
|
|
|
199
206
|
# Examples for each auth method are provided below, use the example that
|
|
200
207
|
# satisfies your auth use case.
|
|
201
208
|
|
|
209
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
210
|
+
|
|
202
211
|
# Configure API key authorization: user
|
|
203
212
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
204
213
|
|
|
@@ -210,6 +219,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
210
219
|
# Create an instance of the API class
|
|
211
220
|
api_instance = compute_api_client.ReservationsApi(api_client)
|
|
212
221
|
latest = True # bool | (optional)
|
|
222
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
223
|
+
page_number = 56 # int | (optional)
|
|
224
|
+
items_per_page = 56 # int | (optional)
|
|
213
225
|
id = 56 # int | (optional)
|
|
214
226
|
member_id = 56 # int | (optional)
|
|
215
227
|
start_time = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
@@ -221,7 +233,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
221
233
|
|
|
222
234
|
try:
|
|
223
235
|
# List reservations
|
|
224
|
-
api_response = await api_instance.read_reservations_reservations_get(latest=latest, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated)
|
|
236
|
+
api_response = await api_instance.read_reservations_reservations_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated)
|
|
225
237
|
print("The response of ReservationsApi->read_reservations_reservations_get:\n")
|
|
226
238
|
pprint(api_response)
|
|
227
239
|
except Exception as e:
|
|
@@ -235,6 +247,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
235
247
|
Name | Type | Description | Notes
|
|
236
248
|
------------- | ------------- | ------------- | -------------
|
|
237
249
|
**latest** | **bool**| | [optional]
|
|
250
|
+
**sort_by** | **str**| | [optional]
|
|
251
|
+
**page_number** | **int**| | [optional]
|
|
252
|
+
**items_per_page** | **int**| | [optional]
|
|
238
253
|
**id** | **int**| | [optional]
|
|
239
254
|
**member_id** | **int**| | [optional]
|
|
240
255
|
**start_time** | **datetime**| | [optional]
|
|
@@ -250,7 +265,7 @@ Name | Type | Description | Notes
|
|
|
250
265
|
|
|
251
266
|
### Authorization
|
|
252
267
|
|
|
253
|
-
[user](../README.md#user)
|
|
268
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
254
269
|
|
|
255
270
|
### HTTP request headers
|
|
256
271
|
|
|
@@ -274,6 +289,7 @@ Terminate reservation by ID.
|
|
|
274
289
|
|
|
275
290
|
### Example
|
|
276
291
|
|
|
292
|
+
* OAuth Authentication (user_bearer):
|
|
277
293
|
* Api Key Authentication (user):
|
|
278
294
|
```python
|
|
279
295
|
import time
|
|
@@ -294,6 +310,8 @@ configuration = compute_api_client.Configuration(
|
|
|
294
310
|
# Examples for each auth method are provided below, use the example that
|
|
295
311
|
# satisfies your auth use case.
|
|
296
312
|
|
|
313
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
314
|
+
|
|
297
315
|
# Configure API key authorization: user
|
|
298
316
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
299
317
|
|
|
@@ -329,7 +347,7 @@ Name | Type | Description | Notes
|
|
|
329
347
|
|
|
330
348
|
### Authorization
|
|
331
349
|
|
|
332
|
-
[user](../README.md#user)
|
|
350
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
333
351
|
|
|
334
352
|
### HTTP request headers
|
|
335
353
|
|
|
@@ -5,8 +5,9 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**create_result_results_post**](ResultsApi.md#create_result_results_post) | **POST** /results | Create result
|
|
8
|
+
[**delete_results_by_job_id_results_job_job_id_delete**](ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete) | **DELETE** /results/job/{job_id} | Delete results by job ID
|
|
8
9
|
[**read_result_results_id_get**](ResultsApi.md#read_result_results_id_get) | **GET** /results/{id} | Retrieve result
|
|
9
|
-
[**read_results_by_job_id_results_job_job_id_get**](ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve
|
|
10
|
+
[**read_results_by_job_id_results_job_job_id_get**](ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve results by job ID
|
|
10
11
|
|
|
11
12
|
|
|
12
13
|
# **create_result_results_post**
|
|
@@ -89,6 +90,83 @@ Name | Type | Description | Notes
|
|
|
89
90
|
|
|
90
91
|
[[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)
|
|
91
92
|
|
|
93
|
+
# **delete_results_by_job_id_results_job_job_id_delete**
|
|
94
|
+
> delete_results_by_job_id_results_job_job_id_delete(job_id)
|
|
95
|
+
|
|
96
|
+
Delete results by job ID
|
|
97
|
+
|
|
98
|
+
Delete results by job ID.
|
|
99
|
+
|
|
100
|
+
### Example
|
|
101
|
+
|
|
102
|
+
* Api Key Authentication (backend):
|
|
103
|
+
```python
|
|
104
|
+
import time
|
|
105
|
+
import os
|
|
106
|
+
import compute_api_client
|
|
107
|
+
from compute_api_client.rest import ApiException
|
|
108
|
+
from pprint import pprint
|
|
109
|
+
|
|
110
|
+
# Defining the host is optional and defaults to http://localhost
|
|
111
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
112
|
+
configuration = compute_api_client.Configuration(
|
|
113
|
+
host = "http://localhost"
|
|
114
|
+
)
|
|
115
|
+
|
|
116
|
+
# The client must configure the authentication and authorization parameters
|
|
117
|
+
# in accordance with the API server security policy.
|
|
118
|
+
# Examples for each auth method are provided below, use the example that
|
|
119
|
+
# satisfies your auth use case.
|
|
120
|
+
|
|
121
|
+
# Configure API key authorization: backend
|
|
122
|
+
configuration.api_key['backend'] = os.environ["API_KEY"]
|
|
123
|
+
|
|
124
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
125
|
+
# configuration.api_key_prefix['backend'] = 'Bearer'
|
|
126
|
+
|
|
127
|
+
# Enter a context with an instance of the API client
|
|
128
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
129
|
+
# Create an instance of the API class
|
|
130
|
+
api_instance = compute_api_client.ResultsApi(api_client)
|
|
131
|
+
job_id = 56 # int |
|
|
132
|
+
|
|
133
|
+
try:
|
|
134
|
+
# Delete results by job ID
|
|
135
|
+
await api_instance.delete_results_by_job_id_results_job_job_id_delete(job_id)
|
|
136
|
+
except Exception as e:
|
|
137
|
+
print("Exception when calling ResultsApi->delete_results_by_job_id_results_job_job_id_delete: %s\n" % e)
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
Name | Type | Description | Notes
|
|
145
|
+
------------- | ------------- | ------------- | -------------
|
|
146
|
+
**job_id** | **int**| |
|
|
147
|
+
|
|
148
|
+
### Return type
|
|
149
|
+
|
|
150
|
+
void (empty response body)
|
|
151
|
+
|
|
152
|
+
### Authorization
|
|
153
|
+
|
|
154
|
+
[backend](../README.md#backend)
|
|
155
|
+
|
|
156
|
+
### HTTP request headers
|
|
157
|
+
|
|
158
|
+
- **Content-Type**: Not defined
|
|
159
|
+
- **Accept**: application/json
|
|
160
|
+
|
|
161
|
+
### HTTP response details
|
|
162
|
+
| Status code | Description | Response headers |
|
|
163
|
+
|-------------|-------------|------------------|
|
|
164
|
+
**204** | Successful Response | - |
|
|
165
|
+
**404** | Not Found | - |
|
|
166
|
+
**422** | Validation Error | - |
|
|
167
|
+
|
|
168
|
+
[[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)
|
|
169
|
+
|
|
92
170
|
# **read_result_results_id_get**
|
|
93
171
|
> Result read_result_results_id_get(id)
|
|
94
172
|
|
|
@@ -98,6 +176,7 @@ Get result by ID.
|
|
|
98
176
|
|
|
99
177
|
### Example
|
|
100
178
|
|
|
179
|
+
* OAuth Authentication (user_bearer):
|
|
101
180
|
* Api Key Authentication (user):
|
|
102
181
|
```python
|
|
103
182
|
import time
|
|
@@ -118,6 +197,8 @@ configuration = compute_api_client.Configuration(
|
|
|
118
197
|
# Examples for each auth method are provided below, use the example that
|
|
119
198
|
# satisfies your auth use case.
|
|
120
199
|
|
|
200
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
201
|
+
|
|
121
202
|
# Configure API key authorization: user
|
|
122
203
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
123
204
|
|
|
@@ -153,7 +234,7 @@ Name | Type | Description | Notes
|
|
|
153
234
|
|
|
154
235
|
### Authorization
|
|
155
236
|
|
|
156
|
-
[user](../README.md#user)
|
|
237
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
157
238
|
|
|
158
239
|
### HTTP request headers
|
|
159
240
|
|
|
@@ -172,12 +253,13 @@ Name | Type | Description | Notes
|
|
|
172
253
|
# **read_results_by_job_id_results_job_job_id_get**
|
|
173
254
|
> List[Result] read_results_by_job_id_results_job_job_id_get(job_id)
|
|
174
255
|
|
|
175
|
-
Retrieve
|
|
256
|
+
Retrieve results by job ID
|
|
176
257
|
|
|
177
|
-
Get
|
|
258
|
+
Get results by job ID.
|
|
178
259
|
|
|
179
260
|
### Example
|
|
180
261
|
|
|
262
|
+
* OAuth Authentication (user_bearer):
|
|
181
263
|
* Api Key Authentication (user):
|
|
182
264
|
```python
|
|
183
265
|
import time
|
|
@@ -198,6 +280,8 @@ configuration = compute_api_client.Configuration(
|
|
|
198
280
|
# Examples for each auth method are provided below, use the example that
|
|
199
281
|
# satisfies your auth use case.
|
|
200
282
|
|
|
283
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
284
|
+
|
|
201
285
|
# Configure API key authorization: user
|
|
202
286
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
203
287
|
|
|
@@ -211,7 +295,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
211
295
|
job_id = 56 # int |
|
|
212
296
|
|
|
213
297
|
try:
|
|
214
|
-
# Retrieve
|
|
298
|
+
# Retrieve results by job ID
|
|
215
299
|
api_response = await api_instance.read_results_by_job_id_results_job_job_id_get(job_id)
|
|
216
300
|
print("The response of ResultsApi->read_results_by_job_id_results_job_job_id_get:\n")
|
|
217
301
|
pprint(api_response)
|
|
@@ -233,7 +317,7 @@ Name | Type | Description | Notes
|
|
|
233
317
|
|
|
234
318
|
### Authorization
|
|
235
319
|
|
|
236
|
-
[user](../README.md#user)
|
|
320
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
237
321
|
|
|
238
322
|
### HTTP request headers
|
|
239
323
|
|