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

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

Potentially problematic release.


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

Files changed (134) hide show
  1. compute_api_client/__init__.py +20 -1
  2. compute_api_client/api/__init__.py +1 -0
  3. compute_api_client/api/algorithms_api.py +76 -75
  4. compute_api_client/api/backend_api.py +78 -75
  5. compute_api_client/api/backend_types_api.py +95 -75
  6. compute_api_client/api/batch_jobs_api.py +77 -74
  7. compute_api_client/api/commits_api.py +78 -75
  8. compute_api_client/api/files_api.py +78 -75
  9. compute_api_client/api/final_results_api.py +1 -1
  10. compute_api_client/api/health_api.py +290 -0
  11. compute_api_client/api/jobs_api.py +78 -75
  12. compute_api_client/api/languages_api.py +76 -73
  13. compute_api_client/api/members_api.py +78 -75
  14. compute_api_client/api/metadata_api.py +79 -8
  15. compute_api_client/api/permissions_api.py +146 -142
  16. compute_api_client/api/projects_api.py +76 -75
  17. compute_api_client/api/reservations_api.py +78 -75
  18. compute_api_client/api/results_api.py +151 -80
  19. compute_api_client/api/teams_api.py +78 -75
  20. compute_api_client/api/transactions_api.py +78 -75
  21. compute_api_client/api/users_api.py +78 -75
  22. compute_api_client/api_client.py +1 -1
  23. compute_api_client/configuration.py +1 -1
  24. compute_api_client/docs/AlgorithmsApi.md +12 -12
  25. compute_api_client/docs/BackendApi.md +12 -12
  26. compute_api_client/docs/BackendType.md +3 -1
  27. compute_api_client/docs/BackendTypesApi.md +14 -12
  28. compute_api_client/docs/BatchJobsApi.md +12 -12
  29. compute_api_client/docs/CommitsApi.md +12 -12
  30. compute_api_client/docs/FilesApi.md +12 -12
  31. compute_api_client/docs/HealthApi.md +71 -0
  32. compute_api_client/docs/JobsApi.md +12 -12
  33. compute_api_client/docs/LanguagesApi.md +12 -12
  34. compute_api_client/docs/MembersApi.md +12 -12
  35. compute_api_client/docs/MetadataApi.md +12 -4
  36. compute_api_client/docs/PageAlgorithm.md +32 -0
  37. compute_api_client/docs/PageBackend.md +32 -0
  38. compute_api_client/docs/PageBackendType.md +32 -0
  39. compute_api_client/docs/PageBatchJob.md +32 -0
  40. compute_api_client/docs/PageCommit.md +32 -0
  41. compute_api_client/docs/PageFile.md +32 -0
  42. compute_api_client/docs/PageJob.md +32 -0
  43. compute_api_client/docs/PageLanguage.md +32 -0
  44. compute_api_client/docs/PageMember.md +32 -0
  45. compute_api_client/docs/PageMetadata.md +32 -0
  46. compute_api_client/docs/PagePermission.md +32 -0
  47. compute_api_client/docs/PagePermissionGroup.md +32 -0
  48. compute_api_client/docs/PageProject.md +32 -0
  49. compute_api_client/docs/PageReservation.md +32 -0
  50. compute_api_client/docs/PageResult.md +32 -0
  51. compute_api_client/docs/PageTeam.md +32 -0
  52. compute_api_client/docs/PageTransaction.md +32 -0
  53. compute_api_client/docs/PageUser.md +32 -0
  54. compute_api_client/docs/PermissionsApi.md +24 -24
  55. compute_api_client/docs/ProjectsApi.md +12 -12
  56. compute_api_client/docs/ReservationsApi.md +12 -12
  57. compute_api_client/docs/ResultsApi.md +24 -16
  58. compute_api_client/docs/TeamsApi.md +12 -12
  59. compute_api_client/docs/TransactionsApi.md +12 -12
  60. compute_api_client/docs/UsersApi.md +12 -12
  61. compute_api_client/exceptions.py +1 -1
  62. compute_api_client/models/__init__.py +19 -1
  63. compute_api_client/models/algorithm.py +1 -1
  64. compute_api_client/models/algorithm_in.py +1 -1
  65. compute_api_client/models/algorithm_type.py +1 -1
  66. compute_api_client/models/backend.py +1 -1
  67. compute_api_client/models/backend_in.py +1 -1
  68. compute_api_client/models/backend_patch.py +1 -1
  69. compute_api_client/models/backend_status.py +1 -1
  70. compute_api_client/models/backend_type.py +8 -4
  71. compute_api_client/models/backend_with_authentication.py +1 -1
  72. compute_api_client/models/batch_job.py +1 -1
  73. compute_api_client/models/batch_job_in.py +1 -1
  74. compute_api_client/models/batch_job_status.py +1 -1
  75. compute_api_client/models/commit.py +1 -1
  76. compute_api_client/models/commit_in.py +1 -1
  77. compute_api_client/models/compile_stage.py +1 -1
  78. compute_api_client/models/domain.py +1 -1
  79. compute_api_client/models/file.py +1 -1
  80. compute_api_client/models/file_in.py +1 -1
  81. compute_api_client/models/final_result.py +1 -1
  82. compute_api_client/models/final_result_in.py +1 -1
  83. compute_api_client/models/http_not_found_error.py +1 -1
  84. compute_api_client/models/http_validation_error.py +1 -1
  85. compute_api_client/models/job.py +1 -1
  86. compute_api_client/models/job_in.py +1 -1
  87. compute_api_client/models/job_patch.py +1 -1
  88. compute_api_client/models/job_status.py +1 -1
  89. compute_api_client/models/language.py +1 -1
  90. compute_api_client/models/location_inner.py +1 -1
  91. compute_api_client/models/member.py +1 -1
  92. compute_api_client/models/member_in.py +1 -1
  93. compute_api_client/models/metadata.py +1 -1
  94. compute_api_client/models/metadata_in.py +1 -1
  95. compute_api_client/models/page_algorithm.py +125 -0
  96. compute_api_client/models/page_backend.py +125 -0
  97. compute_api_client/models/page_backend_type.py +125 -0
  98. compute_api_client/models/page_batch_job.py +125 -0
  99. compute_api_client/models/page_commit.py +125 -0
  100. compute_api_client/models/page_file.py +125 -0
  101. compute_api_client/models/page_job.py +125 -0
  102. compute_api_client/models/page_language.py +125 -0
  103. compute_api_client/models/page_member.py +125 -0
  104. compute_api_client/models/page_metadata.py +125 -0
  105. compute_api_client/models/page_permission.py +125 -0
  106. compute_api_client/models/page_permission_group.py +125 -0
  107. compute_api_client/models/page_project.py +125 -0
  108. compute_api_client/models/page_reservation.py +125 -0
  109. compute_api_client/models/page_result.py +125 -0
  110. compute_api_client/models/page_team.py +125 -0
  111. compute_api_client/models/page_transaction.py +125 -0
  112. compute_api_client/models/page_user.py +125 -0
  113. compute_api_client/models/permission.py +1 -1
  114. compute_api_client/models/permission_group.py +1 -1
  115. compute_api_client/models/project.py +1 -1
  116. compute_api_client/models/project_in.py +1 -1
  117. compute_api_client/models/project_patch.py +1 -1
  118. compute_api_client/models/reservation.py +1 -1
  119. compute_api_client/models/reservation_in.py +1 -1
  120. compute_api_client/models/result.py +1 -1
  121. compute_api_client/models/result_in.py +1 -1
  122. compute_api_client/models/role.py +1 -1
  123. compute_api_client/models/share_type.py +1 -1
  124. compute_api_client/models/team.py +1 -1
  125. compute_api_client/models/transaction.py +1 -1
  126. compute_api_client/models/user.py +1 -1
  127. compute_api_client/models/user_in.py +1 -1
  128. compute_api_client/models/validation_error.py +1 -1
  129. compute_api_client/rest.py +1 -1
  130. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.35.0.dist-info}/METADATA +22 -3
  131. qi_compute_api_client-0.35.0.dist-info/RECORD +182 -0
  132. qi_compute_api_client-0.32.0.dist-info/RECORD +0 -144
  133. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.35.0.dist-info}/LICENSE.md +0 -0
  134. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.35.0.dist-info}/WHEEL +0 -0
@@ -3,7 +3,7 @@
3
3
  """
4
4
  Quantum Inspire 2
5
5
 
6
- **Sorting and Pagination of list endpoints** The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list. - `latest` - **Type**: Boolean. - **Description**: Get the most recently created object. Defaults to False. - `sort_by` - **Type**: String: - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number` - **Type**: Positive Integer - **Description**: The page number for pagination. Defaults to 1. - `items_per_page` - **Type**: Positive Integer. - **Description**: The number of items per page for pagination. Defaults to 50.
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
7
 
8
8
  The version of the OpenAPI document: 0.1.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -29,8 +29,9 @@ from datetime import datetime
29
29
 
30
30
  from pydantic import StrictBool, StrictInt, StrictStr
31
31
 
32
- from typing import List, Optional
32
+ from typing import Optional
33
33
 
34
+ from compute_api_client.models.page_project import PageProject
34
35
  from compute_api_client.models.project import Project
35
36
  from compute_api_client.models.project_in import ProjectIn
36
37
  from compute_api_client.models.project_patch import ProjectPatch
@@ -1158,16 +1159,16 @@ class ProjectsApi:
1158
1159
  async def read_projects_projects_get(
1159
1160
  self,
1160
1161
  search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
1161
- latest: Optional[StrictBool] = None,
1162
- sort_by: Optional[StrictStr] = None,
1163
- page_number: Optional[StrictInt] = None,
1164
- items_per_page: Optional[StrictInt] = None,
1165
1162
  id: Optional[StrictInt] = None,
1166
1163
  created_on: Optional[datetime] = None,
1167
1164
  owner_id: Optional[StrictInt] = None,
1168
1165
  name: Optional[StrictStr] = None,
1169
1166
  description: Optional[StrictStr] = None,
1170
1167
  starred: Optional[StrictBool] = None,
1168
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1169
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1170
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1171
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1171
1172
  _request_timeout: Union[
1172
1173
  None,
1173
1174
  Annotated[StrictFloat, Field(gt=0)],
@@ -1180,21 +1181,13 @@ class ProjectsApi:
1180
1181
  _content_type: Optional[StrictStr] = None,
1181
1182
  _headers: Optional[Dict[StrictStr, Any]] = None,
1182
1183
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1183
- ) -> List[Project]:
1184
+ ) -> PageProject:
1184
1185
  """List projects
1185
1186
 
1186
1187
  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.
1187
1188
 
1188
1189
  :param search: Substring search for project names or description
1189
1190
  :type search: str
1190
- :param latest:
1191
- :type latest: bool
1192
- :param sort_by:
1193
- :type sort_by: str
1194
- :param page_number:
1195
- :type page_number: int
1196
- :param items_per_page:
1197
- :type items_per_page: int
1198
1191
  :param id:
1199
1192
  :type id: int
1200
1193
  :param created_on:
@@ -1207,6 +1200,14 @@ class ProjectsApi:
1207
1200
  :type description: str
1208
1201
  :param starred:
1209
1202
  :type starred: bool
1203
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1204
+ :type sort_by: str
1205
+ :param latest: If True gets the most recently created object.
1206
+ :type latest: bool
1207
+ :param page: Page number
1208
+ :type page: int
1209
+ :param size: Page size
1210
+ :type size: int
1210
1211
  :param _request_timeout: timeout setting for this request. If one
1211
1212
  number provided, it will be total request
1212
1213
  timeout. It can also be a pair (tuple) of
@@ -1231,16 +1232,16 @@ class ProjectsApi:
1231
1232
 
1232
1233
  _param = self._read_projects_projects_get_serialize(
1233
1234
  search=search,
1234
- latest=latest,
1235
- sort_by=sort_by,
1236
- page_number=page_number,
1237
- items_per_page=items_per_page,
1238
1235
  id=id,
1239
1236
  created_on=created_on,
1240
1237
  owner_id=owner_id,
1241
1238
  name=name,
1242
1239
  description=description,
1243
1240
  starred=starred,
1241
+ sort_by=sort_by,
1242
+ latest=latest,
1243
+ page=page,
1244
+ size=size,
1244
1245
  _request_auth=_request_auth,
1245
1246
  _content_type=_content_type,
1246
1247
  _headers=_headers,
@@ -1248,7 +1249,7 @@ class ProjectsApi:
1248
1249
  )
1249
1250
 
1250
1251
  _response_types_map: Dict[str, Optional[str]] = {
1251
- '200': "List[Project]",
1252
+ '200': "PageProject",
1252
1253
  '422': "HTTPValidationError"
1253
1254
 
1254
1255
  }
@@ -1267,16 +1268,16 @@ class ProjectsApi:
1267
1268
  async def read_projects_projects_get_with_http_info(
1268
1269
  self,
1269
1270
  search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
1270
- latest: Optional[StrictBool] = None,
1271
- sort_by: Optional[StrictStr] = None,
1272
- page_number: Optional[StrictInt] = None,
1273
- items_per_page: Optional[StrictInt] = None,
1274
1271
  id: Optional[StrictInt] = None,
1275
1272
  created_on: Optional[datetime] = None,
1276
1273
  owner_id: Optional[StrictInt] = None,
1277
1274
  name: Optional[StrictStr] = None,
1278
1275
  description: Optional[StrictStr] = None,
1279
1276
  starred: Optional[StrictBool] = None,
1277
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1278
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1279
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1280
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1280
1281
  _request_timeout: Union[
1281
1282
  None,
1282
1283
  Annotated[StrictFloat, Field(gt=0)],
@@ -1289,21 +1290,13 @@ class ProjectsApi:
1289
1290
  _content_type: Optional[StrictStr] = None,
1290
1291
  _headers: Optional[Dict[StrictStr, Any]] = None,
1291
1292
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1292
- ) -> ApiResponse[List[Project]]:
1293
+ ) -> ApiResponse[PageProject]:
1293
1294
  """List projects
1294
1295
 
1295
1296
  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.
1296
1297
 
1297
1298
  :param search: Substring search for project names or description
1298
1299
  :type search: str
1299
- :param latest:
1300
- :type latest: bool
1301
- :param sort_by:
1302
- :type sort_by: str
1303
- :param page_number:
1304
- :type page_number: int
1305
- :param items_per_page:
1306
- :type items_per_page: int
1307
1300
  :param id:
1308
1301
  :type id: int
1309
1302
  :param created_on:
@@ -1316,6 +1309,14 @@ class ProjectsApi:
1316
1309
  :type description: str
1317
1310
  :param starred:
1318
1311
  :type starred: bool
1312
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1313
+ :type sort_by: str
1314
+ :param latest: If True gets the most recently created object.
1315
+ :type latest: bool
1316
+ :param page: Page number
1317
+ :type page: int
1318
+ :param size: Page size
1319
+ :type size: int
1319
1320
  :param _request_timeout: timeout setting for this request. If one
1320
1321
  number provided, it will be total request
1321
1322
  timeout. It can also be a pair (tuple) of
@@ -1340,16 +1341,16 @@ class ProjectsApi:
1340
1341
 
1341
1342
  _param = self._read_projects_projects_get_serialize(
1342
1343
  search=search,
1343
- latest=latest,
1344
- sort_by=sort_by,
1345
- page_number=page_number,
1346
- items_per_page=items_per_page,
1347
1344
  id=id,
1348
1345
  created_on=created_on,
1349
1346
  owner_id=owner_id,
1350
1347
  name=name,
1351
1348
  description=description,
1352
1349
  starred=starred,
1350
+ sort_by=sort_by,
1351
+ latest=latest,
1352
+ page=page,
1353
+ size=size,
1353
1354
  _request_auth=_request_auth,
1354
1355
  _content_type=_content_type,
1355
1356
  _headers=_headers,
@@ -1357,7 +1358,7 @@ class ProjectsApi:
1357
1358
  )
1358
1359
 
1359
1360
  _response_types_map: Dict[str, Optional[str]] = {
1360
- '200': "List[Project]",
1361
+ '200': "PageProject",
1361
1362
  '422': "HTTPValidationError"
1362
1363
 
1363
1364
  }
@@ -1376,16 +1377,16 @@ class ProjectsApi:
1376
1377
  async def read_projects_projects_get_without_preload_content(
1377
1378
  self,
1378
1379
  search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
1379
- latest: Optional[StrictBool] = None,
1380
- sort_by: Optional[StrictStr] = None,
1381
- page_number: Optional[StrictInt] = None,
1382
- items_per_page: Optional[StrictInt] = None,
1383
1380
  id: Optional[StrictInt] = None,
1384
1381
  created_on: Optional[datetime] = None,
1385
1382
  owner_id: Optional[StrictInt] = None,
1386
1383
  name: Optional[StrictStr] = None,
1387
1384
  description: Optional[StrictStr] = None,
1388
1385
  starred: Optional[StrictBool] = None,
1386
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1387
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1388
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1389
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1389
1390
  _request_timeout: Union[
1390
1391
  None,
1391
1392
  Annotated[StrictFloat, Field(gt=0)],
@@ -1405,14 +1406,6 @@ class ProjectsApi:
1405
1406
 
1406
1407
  :param search: Substring search for project names or description
1407
1408
  :type search: str
1408
- :param latest:
1409
- :type latest: bool
1410
- :param sort_by:
1411
- :type sort_by: str
1412
- :param page_number:
1413
- :type page_number: int
1414
- :param items_per_page:
1415
- :type items_per_page: int
1416
1409
  :param id:
1417
1410
  :type id: int
1418
1411
  :param created_on:
@@ -1425,6 +1418,14 @@ class ProjectsApi:
1425
1418
  :type description: str
1426
1419
  :param starred:
1427
1420
  :type starred: bool
1421
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1422
+ :type sort_by: str
1423
+ :param latest: If True gets the most recently created object.
1424
+ :type latest: bool
1425
+ :param page: Page number
1426
+ :type page: int
1427
+ :param size: Page size
1428
+ :type size: int
1428
1429
  :param _request_timeout: timeout setting for this request. If one
1429
1430
  number provided, it will be total request
1430
1431
  timeout. It can also be a pair (tuple) of
@@ -1449,16 +1450,16 @@ class ProjectsApi:
1449
1450
 
1450
1451
  _param = self._read_projects_projects_get_serialize(
1451
1452
  search=search,
1452
- latest=latest,
1453
- sort_by=sort_by,
1454
- page_number=page_number,
1455
- items_per_page=items_per_page,
1456
1453
  id=id,
1457
1454
  created_on=created_on,
1458
1455
  owner_id=owner_id,
1459
1456
  name=name,
1460
1457
  description=description,
1461
1458
  starred=starred,
1459
+ sort_by=sort_by,
1460
+ latest=latest,
1461
+ page=page,
1462
+ size=size,
1462
1463
  _request_auth=_request_auth,
1463
1464
  _content_type=_content_type,
1464
1465
  _headers=_headers,
@@ -1466,7 +1467,7 @@ class ProjectsApi:
1466
1467
  )
1467
1468
 
1468
1469
  _response_types_map: Dict[str, Optional[str]] = {
1469
- '200': "List[Project]",
1470
+ '200': "PageProject",
1470
1471
  '422': "HTTPValidationError"
1471
1472
 
1472
1473
  }
@@ -1480,16 +1481,16 @@ class ProjectsApi:
1480
1481
  def _read_projects_projects_get_serialize(
1481
1482
  self,
1482
1483
  search,
1483
- latest,
1484
- sort_by,
1485
- page_number,
1486
- items_per_page,
1487
1484
  id,
1488
1485
  created_on,
1489
1486
  owner_id,
1490
1487
  name,
1491
1488
  description,
1492
1489
  starred,
1490
+ sort_by,
1491
+ latest,
1492
+ page,
1493
+ size,
1493
1494
  _request_auth,
1494
1495
  _content_type,
1495
1496
  _headers,
@@ -1515,22 +1516,6 @@ class ProjectsApi:
1515
1516
 
1516
1517
  _query_params.append(('search', search))
1517
1518
 
1518
- if latest is not None:
1519
-
1520
- _query_params.append(('latest', latest))
1521
-
1522
- if sort_by is not None:
1523
-
1524
- _query_params.append(('sort_by', sort_by))
1525
-
1526
- if page_number is not None:
1527
-
1528
- _query_params.append(('page_number', page_number))
1529
-
1530
- if items_per_page is not None:
1531
-
1532
- _query_params.append(('items_per_page', items_per_page))
1533
-
1534
1519
  if id is not None:
1535
1520
 
1536
1521
  _query_params.append(('id', id))
@@ -1564,6 +1549,22 @@ class ProjectsApi:
1564
1549
 
1565
1550
  _query_params.append(('starred', starred))
1566
1551
 
1552
+ if sort_by is not None:
1553
+
1554
+ _query_params.append(('sort_by', sort_by))
1555
+
1556
+ if latest is not None:
1557
+
1558
+ _query_params.append(('latest', latest))
1559
+
1560
+ if page is not None:
1561
+
1562
+ _query_params.append(('page', page))
1563
+
1564
+ if size is not None:
1565
+
1566
+ _query_params.append(('size', size))
1567
+
1567
1568
  # process the header parameters
1568
1569
  # process the form parameters
1569
1570
  # process the body parameter
@@ -3,7 +3,7 @@
3
3
  """
4
4
  Quantum Inspire 2
5
5
 
6
- **Sorting and Pagination of list endpoints** The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list. - `latest` - **Type**: Boolean. - **Description**: Get the most recently created object. Defaults to False. - `sort_by` - **Type**: String: - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number` - **Type**: Positive Integer - **Description**: The page number for pagination. Defaults to 1. - `items_per_page` - **Type**: Positive Integer. - **Description**: The number of items per page for pagination. Defaults to 50.
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
7
 
8
8
  The version of the OpenAPI document: 0.1.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -23,12 +23,15 @@ try:
23
23
  except ImportError:
24
24
  from typing_extensions import Annotated
25
25
 
26
+ from pydantic import Field
27
+ from typing_extensions import Annotated
26
28
  from datetime import datetime
27
29
 
28
30
  from pydantic import StrictBool, StrictInt, StrictStr
29
31
 
30
- from typing import List, Optional
32
+ from typing import Optional
31
33
 
34
+ from compute_api_client.models.page_reservation import PageReservation
32
35
  from compute_api_client.models.reservation import Reservation
33
36
  from compute_api_client.models.reservation_in import ReservationIn
34
37
 
@@ -599,10 +602,6 @@ class ReservationsApi:
599
602
  @validate_call
600
603
  async def read_reservations_reservations_get(
601
604
  self,
602
- latest: Optional[StrictBool] = None,
603
- sort_by: Optional[StrictStr] = None,
604
- page_number: Optional[StrictInt] = None,
605
- items_per_page: Optional[StrictInt] = None,
606
605
  id: Optional[StrictInt] = None,
607
606
  member_id: Optional[StrictInt] = None,
608
607
  start_time: Optional[datetime] = None,
@@ -611,6 +610,10 @@ class ReservationsApi:
611
610
  backend_id__isnull: Optional[StrictBool] = None,
612
611
  backend_id: Optional[StrictInt] = None,
613
612
  is_terminated: Optional[StrictBool] = None,
613
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
614
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
615
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
616
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
614
617
  _request_timeout: Union[
615
618
  None,
616
619
  Annotated[StrictFloat, Field(gt=0)],
@@ -623,19 +626,11 @@ class ReservationsApi:
623
626
  _content_type: Optional[StrictStr] = None,
624
627
  _headers: Optional[Dict[StrictStr, Any]] = None,
625
628
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
626
- ) -> List[Reservation]:
629
+ ) -> PageReservation:
627
630
  """List reservations
628
631
 
629
632
  Read reservations.
630
633
 
631
- :param latest:
632
- :type latest: bool
633
- :param sort_by:
634
- :type sort_by: str
635
- :param page_number:
636
- :type page_number: int
637
- :param items_per_page:
638
- :type items_per_page: int
639
634
  :param id:
640
635
  :type id: int
641
636
  :param member_id:
@@ -652,6 +647,14 @@ class ReservationsApi:
652
647
  :type backend_id: int
653
648
  :param is_terminated:
654
649
  :type is_terminated: bool
650
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
651
+ :type sort_by: str
652
+ :param latest: If True gets the most recently created object.
653
+ :type latest: bool
654
+ :param page: Page number
655
+ :type page: int
656
+ :param size: Page size
657
+ :type size: int
655
658
  :param _request_timeout: timeout setting for this request. If one
656
659
  number provided, it will be total request
657
660
  timeout. It can also be a pair (tuple) of
@@ -675,10 +678,6 @@ class ReservationsApi:
675
678
  """ # noqa: E501
676
679
 
677
680
  _param = self._read_reservations_reservations_get_serialize(
678
- latest=latest,
679
- sort_by=sort_by,
680
- page_number=page_number,
681
- items_per_page=items_per_page,
682
681
  id=id,
683
682
  member_id=member_id,
684
683
  start_time=start_time,
@@ -687,6 +686,10 @@ class ReservationsApi:
687
686
  backend_id__isnull=backend_id__isnull,
688
687
  backend_id=backend_id,
689
688
  is_terminated=is_terminated,
689
+ sort_by=sort_by,
690
+ latest=latest,
691
+ page=page,
692
+ size=size,
690
693
  _request_auth=_request_auth,
691
694
  _content_type=_content_type,
692
695
  _headers=_headers,
@@ -694,7 +697,7 @@ class ReservationsApi:
694
697
  )
695
698
 
696
699
  _response_types_map: Dict[str, Optional[str]] = {
697
- '200': "List[Reservation]",
700
+ '200': "PageReservation",
698
701
  '422': "HTTPValidationError"
699
702
 
700
703
  }
@@ -712,10 +715,6 @@ class ReservationsApi:
712
715
  @validate_call
713
716
  async def read_reservations_reservations_get_with_http_info(
714
717
  self,
715
- latest: Optional[StrictBool] = None,
716
- sort_by: Optional[StrictStr] = None,
717
- page_number: Optional[StrictInt] = None,
718
- items_per_page: Optional[StrictInt] = None,
719
718
  id: Optional[StrictInt] = None,
720
719
  member_id: Optional[StrictInt] = None,
721
720
  start_time: Optional[datetime] = None,
@@ -724,6 +723,10 @@ class ReservationsApi:
724
723
  backend_id__isnull: Optional[StrictBool] = None,
725
724
  backend_id: Optional[StrictInt] = None,
726
725
  is_terminated: Optional[StrictBool] = None,
726
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
727
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
728
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
729
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
727
730
  _request_timeout: Union[
728
731
  None,
729
732
  Annotated[StrictFloat, Field(gt=0)],
@@ -736,19 +739,11 @@ class ReservationsApi:
736
739
  _content_type: Optional[StrictStr] = None,
737
740
  _headers: Optional[Dict[StrictStr, Any]] = None,
738
741
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
739
- ) -> ApiResponse[List[Reservation]]:
742
+ ) -> ApiResponse[PageReservation]:
740
743
  """List reservations
741
744
 
742
745
  Read reservations.
743
746
 
744
- :param latest:
745
- :type latest: bool
746
- :param sort_by:
747
- :type sort_by: str
748
- :param page_number:
749
- :type page_number: int
750
- :param items_per_page:
751
- :type items_per_page: int
752
747
  :param id:
753
748
  :type id: int
754
749
  :param member_id:
@@ -765,6 +760,14 @@ class ReservationsApi:
765
760
  :type backend_id: int
766
761
  :param is_terminated:
767
762
  :type is_terminated: bool
763
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
764
+ :type sort_by: str
765
+ :param latest: If True gets the most recently created object.
766
+ :type latest: bool
767
+ :param page: Page number
768
+ :type page: int
769
+ :param size: Page size
770
+ :type size: int
768
771
  :param _request_timeout: timeout setting for this request. If one
769
772
  number provided, it will be total request
770
773
  timeout. It can also be a pair (tuple) of
@@ -788,10 +791,6 @@ class ReservationsApi:
788
791
  """ # noqa: E501
789
792
 
790
793
  _param = self._read_reservations_reservations_get_serialize(
791
- latest=latest,
792
- sort_by=sort_by,
793
- page_number=page_number,
794
- items_per_page=items_per_page,
795
794
  id=id,
796
795
  member_id=member_id,
797
796
  start_time=start_time,
@@ -800,6 +799,10 @@ class ReservationsApi:
800
799
  backend_id__isnull=backend_id__isnull,
801
800
  backend_id=backend_id,
802
801
  is_terminated=is_terminated,
802
+ sort_by=sort_by,
803
+ latest=latest,
804
+ page=page,
805
+ size=size,
803
806
  _request_auth=_request_auth,
804
807
  _content_type=_content_type,
805
808
  _headers=_headers,
@@ -807,7 +810,7 @@ class ReservationsApi:
807
810
  )
808
811
 
809
812
  _response_types_map: Dict[str, Optional[str]] = {
810
- '200': "List[Reservation]",
813
+ '200': "PageReservation",
811
814
  '422': "HTTPValidationError"
812
815
 
813
816
  }
@@ -825,10 +828,6 @@ class ReservationsApi:
825
828
  @validate_call
826
829
  async def read_reservations_reservations_get_without_preload_content(
827
830
  self,
828
- latest: Optional[StrictBool] = None,
829
- sort_by: Optional[StrictStr] = None,
830
- page_number: Optional[StrictInt] = None,
831
- items_per_page: Optional[StrictInt] = None,
832
831
  id: Optional[StrictInt] = None,
833
832
  member_id: Optional[StrictInt] = None,
834
833
  start_time: Optional[datetime] = None,
@@ -837,6 +836,10 @@ class ReservationsApi:
837
836
  backend_id__isnull: Optional[StrictBool] = None,
838
837
  backend_id: Optional[StrictInt] = None,
839
838
  is_terminated: Optional[StrictBool] = None,
839
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
840
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
841
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
842
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
840
843
  _request_timeout: Union[
841
844
  None,
842
845
  Annotated[StrictFloat, Field(gt=0)],
@@ -854,14 +857,6 @@ class ReservationsApi:
854
857
 
855
858
  Read reservations.
856
859
 
857
- :param latest:
858
- :type latest: bool
859
- :param sort_by:
860
- :type sort_by: str
861
- :param page_number:
862
- :type page_number: int
863
- :param items_per_page:
864
- :type items_per_page: int
865
860
  :param id:
866
861
  :type id: int
867
862
  :param member_id:
@@ -878,6 +873,14 @@ class ReservationsApi:
878
873
  :type backend_id: int
879
874
  :param is_terminated:
880
875
  :type is_terminated: bool
876
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
877
+ :type sort_by: str
878
+ :param latest: If True gets the most recently created object.
879
+ :type latest: bool
880
+ :param page: Page number
881
+ :type page: int
882
+ :param size: Page size
883
+ :type size: int
881
884
  :param _request_timeout: timeout setting for this request. If one
882
885
  number provided, it will be total request
883
886
  timeout. It can also be a pair (tuple) of
@@ -901,10 +904,6 @@ class ReservationsApi:
901
904
  """ # noqa: E501
902
905
 
903
906
  _param = self._read_reservations_reservations_get_serialize(
904
- latest=latest,
905
- sort_by=sort_by,
906
- page_number=page_number,
907
- items_per_page=items_per_page,
908
907
  id=id,
909
908
  member_id=member_id,
910
909
  start_time=start_time,
@@ -913,6 +912,10 @@ class ReservationsApi:
913
912
  backend_id__isnull=backend_id__isnull,
914
913
  backend_id=backend_id,
915
914
  is_terminated=is_terminated,
915
+ sort_by=sort_by,
916
+ latest=latest,
917
+ page=page,
918
+ size=size,
916
919
  _request_auth=_request_auth,
917
920
  _content_type=_content_type,
918
921
  _headers=_headers,
@@ -920,7 +923,7 @@ class ReservationsApi:
920
923
  )
921
924
 
922
925
  _response_types_map: Dict[str, Optional[str]] = {
923
- '200': "List[Reservation]",
926
+ '200': "PageReservation",
924
927
  '422': "HTTPValidationError"
925
928
 
926
929
  }
@@ -933,10 +936,6 @@ class ReservationsApi:
933
936
 
934
937
  def _read_reservations_reservations_get_serialize(
935
938
  self,
936
- latest,
937
- sort_by,
938
- page_number,
939
- items_per_page,
940
939
  id,
941
940
  member_id,
942
941
  start_time,
@@ -945,6 +944,10 @@ class ReservationsApi:
945
944
  backend_id__isnull,
946
945
  backend_id,
947
946
  is_terminated,
947
+ sort_by,
948
+ latest,
949
+ page,
950
+ size,
948
951
  _request_auth,
949
952
  _content_type,
950
953
  _headers,
@@ -966,22 +969,6 @@ class ReservationsApi:
966
969
 
967
970
  # process the path parameters
968
971
  # process the query parameters
969
- if latest is not None:
970
-
971
- _query_params.append(('latest', latest))
972
-
973
- if sort_by is not None:
974
-
975
- _query_params.append(('sort_by', sort_by))
976
-
977
- if page_number is not None:
978
-
979
- _query_params.append(('page_number', page_number))
980
-
981
- if items_per_page is not None:
982
-
983
- _query_params.append(('items_per_page', items_per_page))
984
-
985
972
  if id is not None:
986
973
 
987
974
  _query_params.append(('id', id))
@@ -1032,6 +1019,22 @@ class ReservationsApi:
1032
1019
 
1033
1020
  _query_params.append(('is_terminated', is_terminated))
1034
1021
 
1022
+ if sort_by is not None:
1023
+
1024
+ _query_params.append(('sort_by', sort_by))
1025
+
1026
+ if latest is not None:
1027
+
1028
+ _query_params.append(('latest', latest))
1029
+
1030
+ if page is not None:
1031
+
1032
+ _query_params.append(('page', page))
1033
+
1034
+ if size is not None:
1035
+
1036
+ _query_params.append(('size', size))
1037
+
1035
1038
  # process the header parameters
1036
1039
  # process the form parameters
1037
1040
  # process the body parameter