qi-compute-api-client 0.7.0__py3-none-any.whl → 0.17.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 +22 -19
- compute_api_client/api/__init__.py +5 -6
- compute_api_client/api/algorithms_api.py +1333 -553
- compute_api_client/api/backend_api.py +1501 -0
- compute_api_client/api/backend_types_api.py +684 -0
- compute_api_client/api/batch_jobs_api.py +1937 -0
- compute_api_client/api/commits_api.py +1068 -435
- compute_api_client/api/files_api.py +1075 -435
- compute_api_client/api/final_results_api.py +736 -338
- compute_api_client/api/jobs_api.py +1653 -0
- compute_api_client/api/languages_api.py +556 -217
- compute_api_client/api/members_api.py +1057 -435
- compute_api_client/api/metadata_api.py +736 -337
- compute_api_client/api/permissions_api.py +1055 -421
- compute_api_client/api/projects_api.py +1604 -676
- compute_api_client/api/reservations_api.py +1124 -427
- compute_api_client/api/results_api.py +738 -337
- compute_api_client/api/teams_api.py +567 -220
- compute_api_client/api/transactions_api.py +679 -218
- compute_api_client/api/users_api.py +1090 -435
- compute_api_client/api_client.py +346 -304
- compute_api_client/api_response.py +21 -0
- compute_api_client/configuration.py +54 -67
- compute_api_client/docs/Algorithm.md +20 -3
- compute_api_client/docs/AlgorithmIn.md +20 -3
- compute_api_client/docs/AlgorithmType.md +0 -1
- compute_api_client/docs/AlgorithmsApi.md +78 -77
- compute_api_client/docs/Backend.md +33 -0
- compute_api_client/docs/BackendApi.md +419 -0
- compute_api_client/docs/BackendPatch.md +29 -0
- compute_api_client/docs/{RunStatus.md → BackendStatus.md} +1 -2
- compute_api_client/docs/BackendType.md +36 -0
- compute_api_client/docs/{RuntimeTypesApi.md → BackendTypesApi.md} +58 -31
- compute_api_client/docs/BackendWithAuthentication.md +34 -0
- compute_api_client/docs/BatchJob.md +38 -0
- compute_api_client/docs/BatchJobIn.md +29 -0
- compute_api_client/docs/{RuntimeStatus.md → BatchJobStatus.md} +1 -2
- compute_api_client/docs/{BatchRunsApi.md → BatchJobsApi.md} +170 -147
- compute_api_client/docs/Commit.md +18 -1
- compute_api_client/docs/CommitIn.md +17 -0
- compute_api_client/docs/CommitsApi.md +62 -71
- compute_api_client/docs/CompileStage.md +0 -1
- compute_api_client/docs/Domain.md +0 -1
- compute_api_client/docs/File.md +21 -4
- compute_api_client/docs/FileIn.md +21 -4
- compute_api_client/docs/FilesApi.md +65 -71
- compute_api_client/docs/FinalResult.md +20 -3
- compute_api_client/docs/FinalResultIn.md +19 -2
- compute_api_client/docs/FinalResultsApi.md +44 -71
- compute_api_client/docs/HTTPNotFoundError.md +17 -0
- compute_api_client/docs/HTTPValidationError.md +18 -1
- compute_api_client/docs/Job.md +36 -0
- compute_api_client/docs/JobIn.md +31 -0
- compute_api_client/docs/JobPatch.md +28 -0
- compute_api_client/docs/{BatchRunStatus.md → JobStatus.md} +1 -2
- compute_api_client/docs/{RunsApi.md → JobsApi.md} +137 -122
- compute_api_client/docs/Language.md +17 -0
- compute_api_client/docs/LanguagesApi.md +30 -12
- compute_api_client/docs/LocationInner.md +17 -0
- compute_api_client/docs/Member.md +19 -2
- compute_api_client/docs/MemberIn.md +19 -2
- compute_api_client/docs/MembersApi.md +59 -24
- compute_api_client/docs/Metadata.md +20 -3
- compute_api_client/docs/MetadataApi.md +49 -33
- compute_api_client/docs/MetadataIn.md +19 -2
- compute_api_client/docs/Permission.md +17 -0
- compute_api_client/docs/PermissionGroup.md +17 -0
- compute_api_client/docs/PermissionsApi.md +68 -28
- compute_api_client/docs/Project.md +20 -3
- compute_api_client/docs/ProjectIn.md +18 -1
- compute_api_client/docs/ProjectPatch.md +19 -2
- compute_api_client/docs/ProjectsApi.md +84 -36
- compute_api_client/docs/Reservation.md +21 -4
- compute_api_client/docs/ReservationIn.md +19 -2
- compute_api_client/docs/ReservationsApi.md +66 -24
- compute_api_client/docs/Result.md +23 -6
- compute_api_client/docs/ResultIn.md +19 -2
- compute_api_client/docs/ResultsApi.md +42 -26
- compute_api_client/docs/Role.md +0 -1
- compute_api_client/docs/ShareType.md +0 -1
- compute_api_client/docs/Team.md +18 -1
- compute_api_client/docs/TeamsApi.md +37 -14
- compute_api_client/docs/Transaction.md +21 -4
- compute_api_client/docs/TransactionsApi.md +50 -14
- compute_api_client/docs/User.md +21 -4
- compute_api_client/docs/UserIn.md +17 -0
- compute_api_client/docs/UsersApi.md +62 -24
- compute_api_client/docs/ValidationError.md +18 -1
- compute_api_client/exceptions.py +19 -16
- compute_api_client/models/__init__.py +16 -14
- compute_api_client/models/algorithm.py +78 -237
- compute_api_client/models/algorithm_in.py +76 -204
- compute_api_client/models/algorithm_type.py +21 -87
- compute_api_client/models/backend.py +100 -0
- compute_api_client/models/backend_patch.py +90 -0
- compute_api_client/models/backend_status.py +47 -0
- compute_api_client/models/backend_type.py +105 -0
- compute_api_client/models/backend_with_authentication.py +102 -0
- compute_api_client/models/batch_job.py +129 -0
- compute_api_client/models/batch_job_in.py +89 -0
- compute_api_client/models/batch_job_status.py +48 -0
- compute_api_client/models/commit.py +72 -230
- compute_api_client/models/commit_in.py +67 -169
- compute_api_client/models/compile_stage.py +23 -89
- compute_api_client/models/domain.py +22 -88
- compute_api_client/models/file.py +74 -288
- compute_api_client/models/file_in.py +72 -254
- compute_api_client/models/final_result.py +68 -198
- compute_api_client/models/final_result_in.py +63 -137
- compute_api_client/models/http_not_found_error.py +60 -105
- compute_api_client/models/http_validation_error.py +69 -105
- compute_api_client/models/job.py +120 -0
- compute_api_client/models/job_in.py +99 -0
- compute_api_client/models/job_patch.py +88 -0
- compute_api_client/models/job_status.py +48 -0
- compute_api_client/models/language.py +67 -172
- compute_api_client/models/location_inner.py +125 -84
- compute_api_client/models/member.py +70 -236
- compute_api_client/models/member_in.py +68 -203
- compute_api_client/models/metadata.py +68 -198
- compute_api_client/models/metadata_in.py +68 -137
- compute_api_client/models/permission.py +67 -172
- compute_api_client/models/permission_group.py +65 -142
- compute_api_client/models/project.py +74 -256
- compute_api_client/models/project_in.py +69 -195
- compute_api_client/models/project_patch.py +89 -192
- compute_api_client/models/reservation.py +79 -290
- compute_api_client/models/reservation_in.py +68 -200
- compute_api_client/models/result.py +101 -359
- compute_api_client/models/result_in.py +95 -291
- compute_api_client/models/role.py +21 -87
- compute_api_client/models/share_type.py +22 -88
- compute_api_client/models/team.py +69 -198
- compute_api_client/models/transaction.py +93 -299
- compute_api_client/models/user.py +75 -276
- compute_api_client/models/user_in.py +73 -243
- compute_api_client/models/validation_error.py +73 -160
- compute_api_client/rest.py +55 -114
- {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/METADATA +47 -40
- qi_compute_api_client-0.17.0.dist-info/RECORD +142 -0
- compute_api_client/api/batch_runs_api.py +0 -862
- compute_api_client/api/runs_api.py +0 -723
- compute_api_client/api/runtime_api.py +0 -449
- compute_api_client/api/runtime_types_api.py +0 -303
- compute_api_client/docs/BatchRun.md +0 -21
- compute_api_client/docs/BatchRunIn.md +0 -12
- compute_api_client/docs/Run.md +0 -19
- compute_api_client/docs/RunIn.md +0 -14
- compute_api_client/docs/Runtime.md +0 -16
- compute_api_client/docs/RuntimeApi.md +0 -229
- compute_api_client/docs/RuntimeType.md +0 -19
- compute_api_client/docs/RuntimeWithAuthentication.md +0 -17
- compute_api_client/models/batch_run.py +0 -423
- compute_api_client/models/batch_run_in.py +0 -171
- compute_api_client/models/batch_run_status.py +0 -114
- compute_api_client/models/run.py +0 -376
- compute_api_client/models/run_in.py +0 -233
- compute_api_client/models/run_status.py +0 -114
- compute_api_client/models/runtime.py +0 -290
- compute_api_client/models/runtime_status.py +0 -113
- compute_api_client/models/runtime_type.py +0 -357
- compute_api_client/models/runtime_with_authentication.py +0 -320
- qi_compute_api_client-0.7.0.dist-info/RECORD +0 -137
- {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/LICENSE.md +0 -0
- {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/WHEEL +0 -0
|
@@ -21,11 +21,13 @@ Get permission group by ID.
|
|
|
21
21
|
|
|
22
22
|
* Api Key Authentication (user):
|
|
23
23
|
```python
|
|
24
|
-
from __future__ import print_function
|
|
25
24
|
import time
|
|
25
|
+
import os
|
|
26
26
|
import compute_api_client
|
|
27
|
+
from compute_api_client.models.permission_group import PermissionGroup
|
|
27
28
|
from compute_api_client.rest import ApiException
|
|
28
29
|
from pprint import pprint
|
|
30
|
+
|
|
29
31
|
# Defining the host is optional and defaults to http://localhost
|
|
30
32
|
# See configuration.py for a list of all supported configuration parameters.
|
|
31
33
|
configuration = compute_api_client.Configuration(
|
|
@@ -38,25 +40,28 @@ configuration = compute_api_client.Configuration(
|
|
|
38
40
|
# satisfies your auth use case.
|
|
39
41
|
|
|
40
42
|
# Configure API key authorization: user
|
|
41
|
-
configuration.api_key['user'] =
|
|
43
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
42
44
|
|
|
43
45
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
44
46
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
45
47
|
|
|
46
48
|
# Enter a context with an instance of the API client
|
|
47
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
49
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
48
50
|
# Create an instance of the API class
|
|
49
51
|
api_instance = compute_api_client.PermissionsApi(api_client)
|
|
50
52
|
id = 56 # int |
|
|
51
53
|
|
|
52
54
|
try:
|
|
53
55
|
# Retrieve permission groups
|
|
54
|
-
api_response = api_instance.read_permission_group_permission_groups_id_get(id)
|
|
56
|
+
api_response = await api_instance.read_permission_group_permission_groups_id_get(id)
|
|
57
|
+
print("The response of PermissionsApi->read_permission_group_permission_groups_id_get:\n")
|
|
55
58
|
pprint(api_response)
|
|
56
|
-
except
|
|
59
|
+
except Exception as e:
|
|
57
60
|
print("Exception when calling PermissionsApi->read_permission_group_permission_groups_id_get: %s\n" % e)
|
|
58
61
|
```
|
|
59
62
|
|
|
63
|
+
|
|
64
|
+
|
|
60
65
|
### Parameters
|
|
61
66
|
|
|
62
67
|
Name | Type | Description | Notes
|
|
@@ -86,7 +91,7 @@ Name | Type | Description | Notes
|
|
|
86
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)
|
|
87
92
|
|
|
88
93
|
# **read_permission_groups_permission_groups_get**
|
|
89
|
-
>
|
|
94
|
+
> List[PermissionGroup] read_permission_groups_permission_groups_get(latest=latest, id=id, name=name)
|
|
90
95
|
|
|
91
96
|
List permission groups
|
|
92
97
|
|
|
@@ -96,11 +101,13 @@ Read permissions groups.
|
|
|
96
101
|
|
|
97
102
|
* Api Key Authentication (user):
|
|
98
103
|
```python
|
|
99
|
-
from __future__ import print_function
|
|
100
104
|
import time
|
|
105
|
+
import os
|
|
101
106
|
import compute_api_client
|
|
107
|
+
from compute_api_client.models.permission_group import PermissionGroup
|
|
102
108
|
from compute_api_client.rest import ApiException
|
|
103
109
|
from pprint import pprint
|
|
110
|
+
|
|
104
111
|
# Defining the host is optional and defaults to http://localhost
|
|
105
112
|
# See configuration.py for a list of all supported configuration parameters.
|
|
106
113
|
configuration = compute_api_client.Configuration(
|
|
@@ -113,30 +120,41 @@ configuration = compute_api_client.Configuration(
|
|
|
113
120
|
# satisfies your auth use case.
|
|
114
121
|
|
|
115
122
|
# Configure API key authorization: user
|
|
116
|
-
configuration.api_key['user'] =
|
|
123
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
117
124
|
|
|
118
125
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
119
126
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
120
127
|
|
|
121
128
|
# Enter a context with an instance of the API client
|
|
122
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
129
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
123
130
|
# Create an instance of the API class
|
|
124
131
|
api_instance = compute_api_client.PermissionsApi(api_client)
|
|
125
|
-
|
|
132
|
+
latest = True # bool | (optional)
|
|
133
|
+
id = 56 # int | (optional)
|
|
134
|
+
name = 'name_example' # str | (optional)
|
|
135
|
+
|
|
126
136
|
try:
|
|
127
137
|
# List permission groups
|
|
128
|
-
api_response = api_instance.read_permission_groups_permission_groups_get()
|
|
138
|
+
api_response = await api_instance.read_permission_groups_permission_groups_get(latest=latest, id=id, name=name)
|
|
139
|
+
print("The response of PermissionsApi->read_permission_groups_permission_groups_get:\n")
|
|
129
140
|
pprint(api_response)
|
|
130
|
-
except
|
|
141
|
+
except Exception as e:
|
|
131
142
|
print("Exception when calling PermissionsApi->read_permission_groups_permission_groups_get: %s\n" % e)
|
|
132
143
|
```
|
|
133
144
|
|
|
145
|
+
|
|
146
|
+
|
|
134
147
|
### Parameters
|
|
135
|
-
|
|
148
|
+
|
|
149
|
+
Name | Type | Description | Notes
|
|
150
|
+
------------- | ------------- | ------------- | -------------
|
|
151
|
+
**latest** | **bool**| | [optional]
|
|
152
|
+
**id** | **int**| | [optional]
|
|
153
|
+
**name** | **str**| | [optional]
|
|
136
154
|
|
|
137
155
|
### Return type
|
|
138
156
|
|
|
139
|
-
[**
|
|
157
|
+
[**List[PermissionGroup]**](PermissionGroup.md)
|
|
140
158
|
|
|
141
159
|
### Authorization
|
|
142
160
|
|
|
@@ -151,6 +169,7 @@ This endpoint does not need any parameter.
|
|
|
151
169
|
| Status code | Description | Response headers |
|
|
152
170
|
|-------------|-------------|------------------|
|
|
153
171
|
**200** | Successful Response | - |
|
|
172
|
+
**422** | Validation Error | - |
|
|
154
173
|
|
|
155
174
|
[[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)
|
|
156
175
|
|
|
@@ -165,11 +184,13 @@ Get permission by ID.
|
|
|
165
184
|
|
|
166
185
|
* Api Key Authentication (user):
|
|
167
186
|
```python
|
|
168
|
-
from __future__ import print_function
|
|
169
187
|
import time
|
|
188
|
+
import os
|
|
170
189
|
import compute_api_client
|
|
190
|
+
from compute_api_client.models.permission import Permission
|
|
171
191
|
from compute_api_client.rest import ApiException
|
|
172
192
|
from pprint import pprint
|
|
193
|
+
|
|
173
194
|
# Defining the host is optional and defaults to http://localhost
|
|
174
195
|
# See configuration.py for a list of all supported configuration parameters.
|
|
175
196
|
configuration = compute_api_client.Configuration(
|
|
@@ -182,25 +203,28 @@ configuration = compute_api_client.Configuration(
|
|
|
182
203
|
# satisfies your auth use case.
|
|
183
204
|
|
|
184
205
|
# Configure API key authorization: user
|
|
185
|
-
configuration.api_key['user'] =
|
|
206
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
186
207
|
|
|
187
208
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
188
209
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
189
210
|
|
|
190
211
|
# Enter a context with an instance of the API client
|
|
191
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
212
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
192
213
|
# Create an instance of the API class
|
|
193
214
|
api_instance = compute_api_client.PermissionsApi(api_client)
|
|
194
215
|
id = 56 # int |
|
|
195
216
|
|
|
196
217
|
try:
|
|
197
218
|
# Retrieve permissions
|
|
198
|
-
api_response = api_instance.read_permission_permissions_id_get(id)
|
|
219
|
+
api_response = await api_instance.read_permission_permissions_id_get(id)
|
|
220
|
+
print("The response of PermissionsApi->read_permission_permissions_id_get:\n")
|
|
199
221
|
pprint(api_response)
|
|
200
|
-
except
|
|
222
|
+
except Exception as e:
|
|
201
223
|
print("Exception when calling PermissionsApi->read_permission_permissions_id_get: %s\n" % e)
|
|
202
224
|
```
|
|
203
225
|
|
|
226
|
+
|
|
227
|
+
|
|
204
228
|
### Parameters
|
|
205
229
|
|
|
206
230
|
Name | Type | Description | Notes
|
|
@@ -230,7 +254,7 @@ Name | Type | Description | Notes
|
|
|
230
254
|
[[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)
|
|
231
255
|
|
|
232
256
|
# **read_permissions_permissions_get**
|
|
233
|
-
>
|
|
257
|
+
> List[Permission] read_permissions_permissions_get(latest=latest, id=id, permission=permission, name=name)
|
|
234
258
|
|
|
235
259
|
List permissions
|
|
236
260
|
|
|
@@ -240,11 +264,13 @@ Read permissions.
|
|
|
240
264
|
|
|
241
265
|
* Api Key Authentication (user):
|
|
242
266
|
```python
|
|
243
|
-
from __future__ import print_function
|
|
244
267
|
import time
|
|
268
|
+
import os
|
|
245
269
|
import compute_api_client
|
|
270
|
+
from compute_api_client.models.permission import Permission
|
|
246
271
|
from compute_api_client.rest import ApiException
|
|
247
272
|
from pprint import pprint
|
|
273
|
+
|
|
248
274
|
# Defining the host is optional and defaults to http://localhost
|
|
249
275
|
# See configuration.py for a list of all supported configuration parameters.
|
|
250
276
|
configuration = compute_api_client.Configuration(
|
|
@@ -257,30 +283,43 @@ configuration = compute_api_client.Configuration(
|
|
|
257
283
|
# satisfies your auth use case.
|
|
258
284
|
|
|
259
285
|
# Configure API key authorization: user
|
|
260
|
-
configuration.api_key['user'] =
|
|
286
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
261
287
|
|
|
262
288
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
263
289
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
264
290
|
|
|
265
291
|
# Enter a context with an instance of the API client
|
|
266
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
292
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
267
293
|
# Create an instance of the API class
|
|
268
294
|
api_instance = compute_api_client.PermissionsApi(api_client)
|
|
269
|
-
|
|
295
|
+
latest = True # bool | (optional)
|
|
296
|
+
id = 56 # int | (optional)
|
|
297
|
+
permission = 'permission_example' # str | (optional)
|
|
298
|
+
name = 'name_example' # str | (optional)
|
|
299
|
+
|
|
270
300
|
try:
|
|
271
301
|
# List permissions
|
|
272
|
-
api_response = api_instance.read_permissions_permissions_get()
|
|
302
|
+
api_response = await api_instance.read_permissions_permissions_get(latest=latest, id=id, permission=permission, name=name)
|
|
303
|
+
print("The response of PermissionsApi->read_permissions_permissions_get:\n")
|
|
273
304
|
pprint(api_response)
|
|
274
|
-
except
|
|
305
|
+
except Exception as e:
|
|
275
306
|
print("Exception when calling PermissionsApi->read_permissions_permissions_get: %s\n" % e)
|
|
276
307
|
```
|
|
277
308
|
|
|
309
|
+
|
|
310
|
+
|
|
278
311
|
### Parameters
|
|
279
|
-
|
|
312
|
+
|
|
313
|
+
Name | Type | Description | Notes
|
|
314
|
+
------------- | ------------- | ------------- | -------------
|
|
315
|
+
**latest** | **bool**| | [optional]
|
|
316
|
+
**id** | **int**| | [optional]
|
|
317
|
+
**permission** | **str**| | [optional]
|
|
318
|
+
**name** | **str**| | [optional]
|
|
280
319
|
|
|
281
320
|
### Return type
|
|
282
321
|
|
|
283
|
-
[**
|
|
322
|
+
[**List[Permission]**](Permission.md)
|
|
284
323
|
|
|
285
324
|
### Authorization
|
|
286
325
|
|
|
@@ -295,6 +334,7 @@ This endpoint does not need any parameter.
|
|
|
295
334
|
| Status code | Description | Response headers |
|
|
296
335
|
|-------------|-------------|------------------|
|
|
297
336
|
**200** | Successful Response | - |
|
|
337
|
+
**422** | Validation Error | - |
|
|
298
338
|
|
|
299
339
|
[[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)
|
|
300
340
|
|
|
@@ -4,13 +4,30 @@
|
|
|
4
4
|
## Properties
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**created_on** | **datetime** | | [readonly]
|
|
8
7
|
**id** | **int** | |
|
|
8
|
+
**created_on** | **datetime** | |
|
|
9
|
+
**owner_id** | **int** | |
|
|
9
10
|
**name** | **str** | |
|
|
10
11
|
**description** | **str** | |
|
|
11
|
-
**starred** | **bool** | |
|
|
12
|
-
|
|
12
|
+
**starred** | **bool** | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```python
|
|
17
|
+
from compute_api_client.models.project import Project
|
|
18
|
+
|
|
19
|
+
# TODO update the JSON string below
|
|
20
|
+
json = "{}"
|
|
21
|
+
# create an instance of Project from a JSON string
|
|
22
|
+
project_instance = Project.from_json(json)
|
|
23
|
+
# print the JSON string representation of the object
|
|
24
|
+
print Project.to_json()
|
|
13
25
|
|
|
26
|
+
# convert the object into a dict
|
|
27
|
+
project_dict = project_instance.to_dict()
|
|
28
|
+
# create an instance of Project from a dict
|
|
29
|
+
project_form_dict = project.from_dict(project_dict)
|
|
30
|
+
```
|
|
14
31
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
15
32
|
|
|
16
33
|
|
|
@@ -4,11 +4,28 @@
|
|
|
4
4
|
## Properties
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**owner_id** | **int** | |
|
|
7
8
|
**name** | **str** | |
|
|
8
9
|
**description** | **str** | |
|
|
9
10
|
**starred** | **bool** | | [optional] [default to False]
|
|
10
|
-
**owner_id** | **int** | |
|
|
11
11
|
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```python
|
|
15
|
+
from compute_api_client.models.project_in import ProjectIn
|
|
16
|
+
|
|
17
|
+
# TODO update the JSON string below
|
|
18
|
+
json = "{}"
|
|
19
|
+
# create an instance of ProjectIn from a JSON string
|
|
20
|
+
project_in_instance = ProjectIn.from_json(json)
|
|
21
|
+
# print the JSON string representation of the object
|
|
22
|
+
print ProjectIn.to_json()
|
|
23
|
+
|
|
24
|
+
# convert the object into a dict
|
|
25
|
+
project_in_dict = project_in_instance.to_dict()
|
|
26
|
+
# create an instance of ProjectIn from a dict
|
|
27
|
+
project_in_form_dict = project_in.from_dict(project_in_dict)
|
|
28
|
+
```
|
|
12
29
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
13
30
|
|
|
14
31
|
|
|
@@ -4,11 +4,28 @@
|
|
|
4
4
|
## Properties
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**owner_id** | **int** | | [optional]
|
|
7
8
|
**name** | **str** | | [optional]
|
|
8
9
|
**description** | **str** | | [optional]
|
|
9
|
-
**starred** | **bool** | | [optional]
|
|
10
|
-
|
|
10
|
+
**starred** | **bool** | | [optional]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```python
|
|
15
|
+
from compute_api_client.models.project_patch import ProjectPatch
|
|
16
|
+
|
|
17
|
+
# TODO update the JSON string below
|
|
18
|
+
json = "{}"
|
|
19
|
+
# create an instance of ProjectPatch from a JSON string
|
|
20
|
+
project_patch_instance = ProjectPatch.from_json(json)
|
|
21
|
+
# print the JSON string representation of the object
|
|
22
|
+
print ProjectPatch.to_json()
|
|
11
23
|
|
|
24
|
+
# convert the object into a dict
|
|
25
|
+
project_patch_dict = project_patch_instance.to_dict()
|
|
26
|
+
# create an instance of ProjectPatch from a dict
|
|
27
|
+
project_patch_form_dict = project_patch.from_dict(project_patch_dict)
|
|
28
|
+
```
|
|
12
29
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
13
30
|
|
|
14
31
|
|
|
@@ -23,11 +23,14 @@ Create new project.
|
|
|
23
23
|
|
|
24
24
|
* Api Key Authentication (user):
|
|
25
25
|
```python
|
|
26
|
-
from __future__ import print_function
|
|
27
26
|
import time
|
|
27
|
+
import os
|
|
28
28
|
import compute_api_client
|
|
29
|
+
from compute_api_client.models.project import Project
|
|
30
|
+
from compute_api_client.models.project_in import ProjectIn
|
|
29
31
|
from compute_api_client.rest import ApiException
|
|
30
32
|
from pprint import pprint
|
|
33
|
+
|
|
31
34
|
# Defining the host is optional and defaults to http://localhost
|
|
32
35
|
# See configuration.py for a list of all supported configuration parameters.
|
|
33
36
|
configuration = compute_api_client.Configuration(
|
|
@@ -40,25 +43,28 @@ configuration = compute_api_client.Configuration(
|
|
|
40
43
|
# satisfies your auth use case.
|
|
41
44
|
|
|
42
45
|
# Configure API key authorization: user
|
|
43
|
-
configuration.api_key['user'] =
|
|
46
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
44
47
|
|
|
45
48
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
46
49
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
47
50
|
|
|
48
51
|
# Enter a context with an instance of the API client
|
|
49
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
52
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
50
53
|
# Create an instance of the API class
|
|
51
54
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
52
55
|
project_in = compute_api_client.ProjectIn() # ProjectIn |
|
|
53
56
|
|
|
54
57
|
try:
|
|
55
58
|
# Create project
|
|
56
|
-
api_response = api_instance.create_project_projects_post(project_in)
|
|
59
|
+
api_response = await api_instance.create_project_projects_post(project_in)
|
|
60
|
+
print("The response of ProjectsApi->create_project_projects_post:\n")
|
|
57
61
|
pprint(api_response)
|
|
58
|
-
except
|
|
62
|
+
except Exception as e:
|
|
59
63
|
print("Exception when calling ProjectsApi->create_project_projects_post: %s\n" % e)
|
|
60
64
|
```
|
|
61
65
|
|
|
66
|
+
|
|
67
|
+
|
|
62
68
|
### Parameters
|
|
63
69
|
|
|
64
70
|
Name | Type | Description | Notes
|
|
@@ -97,11 +103,12 @@ Delete a project.
|
|
|
97
103
|
|
|
98
104
|
* Api Key Authentication (user):
|
|
99
105
|
```python
|
|
100
|
-
from __future__ import print_function
|
|
101
106
|
import time
|
|
107
|
+
import os
|
|
102
108
|
import compute_api_client
|
|
103
109
|
from compute_api_client.rest import ApiException
|
|
104
110
|
from pprint import pprint
|
|
111
|
+
|
|
105
112
|
# Defining the host is optional and defaults to http://localhost
|
|
106
113
|
# See configuration.py for a list of all supported configuration parameters.
|
|
107
114
|
configuration = compute_api_client.Configuration(
|
|
@@ -114,24 +121,26 @@ configuration = compute_api_client.Configuration(
|
|
|
114
121
|
# satisfies your auth use case.
|
|
115
122
|
|
|
116
123
|
# Configure API key authorization: user
|
|
117
|
-
configuration.api_key['user'] =
|
|
124
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
118
125
|
|
|
119
126
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
120
127
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
121
128
|
|
|
122
129
|
# Enter a context with an instance of the API client
|
|
123
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
130
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
124
131
|
# Create an instance of the API class
|
|
125
132
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
126
133
|
id = 56 # int |
|
|
127
134
|
|
|
128
135
|
try:
|
|
129
136
|
# Destroy project
|
|
130
|
-
api_instance.delete_project_projects_id_delete(id)
|
|
131
|
-
except
|
|
137
|
+
await api_instance.delete_project_projects_id_delete(id)
|
|
138
|
+
except Exception as e:
|
|
132
139
|
print("Exception when calling ProjectsApi->delete_project_projects_id_delete: %s\n" % e)
|
|
133
140
|
```
|
|
134
141
|
|
|
142
|
+
|
|
143
|
+
|
|
135
144
|
### Parameters
|
|
136
145
|
|
|
137
146
|
Name | Type | Description | Notes
|
|
@@ -171,11 +180,14 @@ Partially update a project.
|
|
|
171
180
|
|
|
172
181
|
* Api Key Authentication (user):
|
|
173
182
|
```python
|
|
174
|
-
from __future__ import print_function
|
|
175
183
|
import time
|
|
184
|
+
import os
|
|
176
185
|
import compute_api_client
|
|
186
|
+
from compute_api_client.models.project import Project
|
|
187
|
+
from compute_api_client.models.project_patch import ProjectPatch
|
|
177
188
|
from compute_api_client.rest import ApiException
|
|
178
189
|
from pprint import pprint
|
|
190
|
+
|
|
179
191
|
# Defining the host is optional and defaults to http://localhost
|
|
180
192
|
# See configuration.py for a list of all supported configuration parameters.
|
|
181
193
|
configuration = compute_api_client.Configuration(
|
|
@@ -188,26 +200,29 @@ configuration = compute_api_client.Configuration(
|
|
|
188
200
|
# satisfies your auth use case.
|
|
189
201
|
|
|
190
202
|
# Configure API key authorization: user
|
|
191
|
-
configuration.api_key['user'] =
|
|
203
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
192
204
|
|
|
193
205
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
194
206
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
195
207
|
|
|
196
208
|
# Enter a context with an instance of the API client
|
|
197
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
209
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
198
210
|
# Create an instance of the API class
|
|
199
211
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
200
212
|
id = 56 # int |
|
|
201
|
-
project_patch = compute_api_client.ProjectPatch() # ProjectPatch |
|
|
213
|
+
project_patch = compute_api_client.ProjectPatch() # ProjectPatch |
|
|
202
214
|
|
|
203
215
|
try:
|
|
204
216
|
# Partially update project
|
|
205
|
-
api_response = api_instance.partial_update_project_projects_id_patch(id, project_patch)
|
|
217
|
+
api_response = await api_instance.partial_update_project_projects_id_patch(id, project_patch)
|
|
218
|
+
print("The response of ProjectsApi->partial_update_project_projects_id_patch:\n")
|
|
206
219
|
pprint(api_response)
|
|
207
|
-
except
|
|
220
|
+
except Exception as e:
|
|
208
221
|
print("Exception when calling ProjectsApi->partial_update_project_projects_id_patch: %s\n" % e)
|
|
209
222
|
```
|
|
210
223
|
|
|
224
|
+
|
|
225
|
+
|
|
211
226
|
### Parameters
|
|
212
227
|
|
|
213
228
|
Name | Type | Description | Notes
|
|
@@ -248,11 +263,13 @@ Get project by ID.
|
|
|
248
263
|
|
|
249
264
|
* Api Key Authentication (user):
|
|
250
265
|
```python
|
|
251
|
-
from __future__ import print_function
|
|
252
266
|
import time
|
|
267
|
+
import os
|
|
253
268
|
import compute_api_client
|
|
269
|
+
from compute_api_client.models.project import Project
|
|
254
270
|
from compute_api_client.rest import ApiException
|
|
255
271
|
from pprint import pprint
|
|
272
|
+
|
|
256
273
|
# Defining the host is optional and defaults to http://localhost
|
|
257
274
|
# See configuration.py for a list of all supported configuration parameters.
|
|
258
275
|
configuration = compute_api_client.Configuration(
|
|
@@ -265,25 +282,28 @@ configuration = compute_api_client.Configuration(
|
|
|
265
282
|
# satisfies your auth use case.
|
|
266
283
|
|
|
267
284
|
# Configure API key authorization: user
|
|
268
|
-
configuration.api_key['user'] =
|
|
285
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
269
286
|
|
|
270
287
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
271
288
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
272
289
|
|
|
273
290
|
# Enter a context with an instance of the API client
|
|
274
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
291
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
275
292
|
# Create an instance of the API class
|
|
276
293
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
277
294
|
id = 56 # int |
|
|
278
295
|
|
|
279
296
|
try:
|
|
280
297
|
# Retrieve project
|
|
281
|
-
api_response = api_instance.read_project_projects_id_get(id)
|
|
298
|
+
api_response = await api_instance.read_project_projects_id_get(id)
|
|
299
|
+
print("The response of ProjectsApi->read_project_projects_id_get:\n")
|
|
282
300
|
pprint(api_response)
|
|
283
|
-
except
|
|
301
|
+
except Exception as e:
|
|
284
302
|
print("Exception when calling ProjectsApi->read_project_projects_id_get: %s\n" % e)
|
|
285
303
|
```
|
|
286
304
|
|
|
305
|
+
|
|
306
|
+
|
|
287
307
|
### Parameters
|
|
288
308
|
|
|
289
309
|
Name | Type | Description | Notes
|
|
@@ -313,7 +333,7 @@ Name | Type | Description | Notes
|
|
|
313
333
|
[[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)
|
|
314
334
|
|
|
315
335
|
# **read_projects_projects_get**
|
|
316
|
-
>
|
|
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)
|
|
317
337
|
|
|
318
338
|
List projects
|
|
319
339
|
|
|
@@ -323,11 +343,13 @@ List projects.
|
|
|
323
343
|
|
|
324
344
|
* Api Key Authentication (user):
|
|
325
345
|
```python
|
|
326
|
-
from __future__ import print_function
|
|
327
346
|
import time
|
|
347
|
+
import os
|
|
328
348
|
import compute_api_client
|
|
349
|
+
from compute_api_client.models.project import Project
|
|
329
350
|
from compute_api_client.rest import ApiException
|
|
330
351
|
from pprint import pprint
|
|
352
|
+
|
|
331
353
|
# Defining the host is optional and defaults to http://localhost
|
|
332
354
|
# See configuration.py for a list of all supported configuration parameters.
|
|
333
355
|
configuration = compute_api_client.Configuration(
|
|
@@ -340,30 +362,49 @@ configuration = compute_api_client.Configuration(
|
|
|
340
362
|
# satisfies your auth use case.
|
|
341
363
|
|
|
342
364
|
# Configure API key authorization: user
|
|
343
|
-
configuration.api_key['user'] =
|
|
365
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
344
366
|
|
|
345
367
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
346
368
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
347
369
|
|
|
348
370
|
# Enter a context with an instance of the API client
|
|
349
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
371
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
350
372
|
# Create an instance of the API class
|
|
351
373
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
352
|
-
|
|
374
|
+
latest = True # bool | (optional)
|
|
375
|
+
id = 56 # int | (optional)
|
|
376
|
+
created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
377
|
+
owner_id = 56 # int | (optional)
|
|
378
|
+
name = 'name_example' # str | (optional)
|
|
379
|
+
description = 'description_example' # str | (optional)
|
|
380
|
+
starred = True # bool | (optional)
|
|
381
|
+
|
|
353
382
|
try:
|
|
354
383
|
# List projects
|
|
355
|
-
api_response = api_instance.read_projects_projects_get()
|
|
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)
|
|
385
|
+
print("The response of ProjectsApi->read_projects_projects_get:\n")
|
|
356
386
|
pprint(api_response)
|
|
357
|
-
except
|
|
387
|
+
except Exception as e:
|
|
358
388
|
print("Exception when calling ProjectsApi->read_projects_projects_get: %s\n" % e)
|
|
359
389
|
```
|
|
360
390
|
|
|
391
|
+
|
|
392
|
+
|
|
361
393
|
### Parameters
|
|
362
|
-
|
|
394
|
+
|
|
395
|
+
Name | Type | Description | Notes
|
|
396
|
+
------------- | ------------- | ------------- | -------------
|
|
397
|
+
**latest** | **bool**| | [optional]
|
|
398
|
+
**id** | **int**| | [optional]
|
|
399
|
+
**created_on** | **datetime**| | [optional]
|
|
400
|
+
**owner_id** | **int**| | [optional]
|
|
401
|
+
**name** | **str**| | [optional]
|
|
402
|
+
**description** | **str**| | [optional]
|
|
403
|
+
**starred** | **bool**| | [optional]
|
|
363
404
|
|
|
364
405
|
### Return type
|
|
365
406
|
|
|
366
|
-
[**
|
|
407
|
+
[**List[Project]**](Project.md)
|
|
367
408
|
|
|
368
409
|
### Authorization
|
|
369
410
|
|
|
@@ -378,6 +419,7 @@ This endpoint does not need any parameter.
|
|
|
378
419
|
| Status code | Description | Response headers |
|
|
379
420
|
|-------------|-------------|------------------|
|
|
380
421
|
**200** | Successful Response | - |
|
|
422
|
+
**422** | Validation Error | - |
|
|
381
423
|
|
|
382
424
|
[[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)
|
|
383
425
|
|
|
@@ -392,11 +434,14 @@ Update a project.
|
|
|
392
434
|
|
|
393
435
|
* Api Key Authentication (user):
|
|
394
436
|
```python
|
|
395
|
-
from __future__ import print_function
|
|
396
437
|
import time
|
|
438
|
+
import os
|
|
397
439
|
import compute_api_client
|
|
440
|
+
from compute_api_client.models.project import Project
|
|
441
|
+
from compute_api_client.models.project_in import ProjectIn
|
|
398
442
|
from compute_api_client.rest import ApiException
|
|
399
443
|
from pprint import pprint
|
|
444
|
+
|
|
400
445
|
# Defining the host is optional and defaults to http://localhost
|
|
401
446
|
# See configuration.py for a list of all supported configuration parameters.
|
|
402
447
|
configuration = compute_api_client.Configuration(
|
|
@@ -409,26 +454,29 @@ configuration = compute_api_client.Configuration(
|
|
|
409
454
|
# satisfies your auth use case.
|
|
410
455
|
|
|
411
456
|
# Configure API key authorization: user
|
|
412
|
-
configuration.api_key['user'] =
|
|
457
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
413
458
|
|
|
414
459
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
415
460
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
416
461
|
|
|
417
462
|
# Enter a context with an instance of the API client
|
|
418
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
463
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
419
464
|
# Create an instance of the API class
|
|
420
465
|
api_instance = compute_api_client.ProjectsApi(api_client)
|
|
421
466
|
id = 56 # int |
|
|
422
|
-
project_in = compute_api_client.ProjectIn() # ProjectIn |
|
|
467
|
+
project_in = compute_api_client.ProjectIn() # ProjectIn |
|
|
423
468
|
|
|
424
469
|
try:
|
|
425
470
|
# Update project
|
|
426
|
-
api_response = api_instance.update_project_projects_id_put(id, project_in)
|
|
471
|
+
api_response = await api_instance.update_project_projects_id_put(id, project_in)
|
|
472
|
+
print("The response of ProjectsApi->update_project_projects_id_put:\n")
|
|
427
473
|
pprint(api_response)
|
|
428
|
-
except
|
|
474
|
+
except Exception as e:
|
|
429
475
|
print("Exception when calling ProjectsApi->update_project_projects_id_put: %s\n" % e)
|
|
430
476
|
```
|
|
431
477
|
|
|
478
|
+
|
|
479
|
+
|
|
432
480
|
### Parameters
|
|
433
481
|
|
|
434
482
|
Name | Type | Description | Notes
|