qi-compute-api-client 0.32.0__py3-none-any.whl → 0.33.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 (130) hide show
  1. compute_api_client/__init__.py +19 -1
  2. compute_api_client/api/algorithms_api.py +76 -75
  3. compute_api_client/api/backend_api.py +78 -75
  4. compute_api_client/api/backend_types_api.py +78 -75
  5. compute_api_client/api/batch_jobs_api.py +77 -74
  6. compute_api_client/api/commits_api.py +78 -75
  7. compute_api_client/api/files_api.py +78 -75
  8. compute_api_client/api/final_results_api.py +1 -1
  9. compute_api_client/api/jobs_api.py +78 -75
  10. compute_api_client/api/languages_api.py +76 -73
  11. compute_api_client/api/members_api.py +78 -75
  12. compute_api_client/api/metadata_api.py +79 -8
  13. compute_api_client/api/permissions_api.py +146 -142
  14. compute_api_client/api/projects_api.py +76 -75
  15. compute_api_client/api/reservations_api.py +78 -75
  16. compute_api_client/api/results_api.py +151 -80
  17. compute_api_client/api/teams_api.py +78 -75
  18. compute_api_client/api/transactions_api.py +78 -75
  19. compute_api_client/api/users_api.py +78 -75
  20. compute_api_client/api_client.py +1 -1
  21. compute_api_client/configuration.py +1 -1
  22. compute_api_client/docs/AlgorithmsApi.md +12 -12
  23. compute_api_client/docs/BackendApi.md +12 -12
  24. compute_api_client/docs/BackendTypesApi.md +12 -12
  25. compute_api_client/docs/BatchJobsApi.md +12 -12
  26. compute_api_client/docs/CommitsApi.md +12 -12
  27. compute_api_client/docs/FilesApi.md +12 -12
  28. compute_api_client/docs/JobsApi.md +12 -12
  29. compute_api_client/docs/LanguagesApi.md +12 -12
  30. compute_api_client/docs/MembersApi.md +12 -12
  31. compute_api_client/docs/MetadataApi.md +12 -4
  32. compute_api_client/docs/PageAlgorithm.md +32 -0
  33. compute_api_client/docs/PageBackend.md +32 -0
  34. compute_api_client/docs/PageBackendType.md +32 -0
  35. compute_api_client/docs/PageBatchJob.md +32 -0
  36. compute_api_client/docs/PageCommit.md +32 -0
  37. compute_api_client/docs/PageFile.md +32 -0
  38. compute_api_client/docs/PageJob.md +32 -0
  39. compute_api_client/docs/PageLanguage.md +32 -0
  40. compute_api_client/docs/PageMember.md +32 -0
  41. compute_api_client/docs/PageMetadata.md +32 -0
  42. compute_api_client/docs/PagePermission.md +32 -0
  43. compute_api_client/docs/PagePermissionGroup.md +32 -0
  44. compute_api_client/docs/PageProject.md +32 -0
  45. compute_api_client/docs/PageReservation.md +32 -0
  46. compute_api_client/docs/PageResult.md +32 -0
  47. compute_api_client/docs/PageTeam.md +32 -0
  48. compute_api_client/docs/PageTransaction.md +32 -0
  49. compute_api_client/docs/PageUser.md +32 -0
  50. compute_api_client/docs/PermissionsApi.md +24 -24
  51. compute_api_client/docs/ProjectsApi.md +12 -12
  52. compute_api_client/docs/ReservationsApi.md +12 -12
  53. compute_api_client/docs/ResultsApi.md +24 -16
  54. compute_api_client/docs/TeamsApi.md +12 -12
  55. compute_api_client/docs/TransactionsApi.md +12 -12
  56. compute_api_client/docs/UsersApi.md +12 -12
  57. compute_api_client/exceptions.py +1 -1
  58. compute_api_client/models/__init__.py +19 -1
  59. compute_api_client/models/algorithm.py +1 -1
  60. compute_api_client/models/algorithm_in.py +1 -1
  61. compute_api_client/models/algorithm_type.py +1 -1
  62. compute_api_client/models/backend.py +1 -1
  63. compute_api_client/models/backend_in.py +1 -1
  64. compute_api_client/models/backend_patch.py +1 -1
  65. compute_api_client/models/backend_status.py +1 -1
  66. compute_api_client/models/backend_type.py +1 -1
  67. compute_api_client/models/backend_with_authentication.py +1 -1
  68. compute_api_client/models/batch_job.py +1 -1
  69. compute_api_client/models/batch_job_in.py +1 -1
  70. compute_api_client/models/batch_job_status.py +1 -1
  71. compute_api_client/models/commit.py +1 -1
  72. compute_api_client/models/commit_in.py +1 -1
  73. compute_api_client/models/compile_stage.py +1 -1
  74. compute_api_client/models/domain.py +1 -1
  75. compute_api_client/models/file.py +1 -1
  76. compute_api_client/models/file_in.py +1 -1
  77. compute_api_client/models/final_result.py +1 -1
  78. compute_api_client/models/final_result_in.py +1 -1
  79. compute_api_client/models/http_not_found_error.py +1 -1
  80. compute_api_client/models/http_validation_error.py +1 -1
  81. compute_api_client/models/job.py +1 -1
  82. compute_api_client/models/job_in.py +1 -1
  83. compute_api_client/models/job_patch.py +1 -1
  84. compute_api_client/models/job_status.py +1 -1
  85. compute_api_client/models/language.py +1 -1
  86. compute_api_client/models/location_inner.py +1 -1
  87. compute_api_client/models/member.py +1 -1
  88. compute_api_client/models/member_in.py +1 -1
  89. compute_api_client/models/metadata.py +1 -1
  90. compute_api_client/models/metadata_in.py +1 -1
  91. compute_api_client/models/page_algorithm.py +125 -0
  92. compute_api_client/models/page_backend.py +125 -0
  93. compute_api_client/models/page_backend_type.py +125 -0
  94. compute_api_client/models/page_batch_job.py +125 -0
  95. compute_api_client/models/page_commit.py +125 -0
  96. compute_api_client/models/page_file.py +125 -0
  97. compute_api_client/models/page_job.py +125 -0
  98. compute_api_client/models/page_language.py +125 -0
  99. compute_api_client/models/page_member.py +125 -0
  100. compute_api_client/models/page_metadata.py +125 -0
  101. compute_api_client/models/page_permission.py +125 -0
  102. compute_api_client/models/page_permission_group.py +125 -0
  103. compute_api_client/models/page_project.py +125 -0
  104. compute_api_client/models/page_reservation.py +125 -0
  105. compute_api_client/models/page_result.py +125 -0
  106. compute_api_client/models/page_team.py +125 -0
  107. compute_api_client/models/page_transaction.py +125 -0
  108. compute_api_client/models/page_user.py +125 -0
  109. compute_api_client/models/permission.py +1 -1
  110. compute_api_client/models/permission_group.py +1 -1
  111. compute_api_client/models/project.py +1 -1
  112. compute_api_client/models/project_in.py +1 -1
  113. compute_api_client/models/project_patch.py +1 -1
  114. compute_api_client/models/reservation.py +1 -1
  115. compute_api_client/models/reservation_in.py +1 -1
  116. compute_api_client/models/result.py +1 -1
  117. compute_api_client/models/result_in.py +1 -1
  118. compute_api_client/models/role.py +1 -1
  119. compute_api_client/models/share_type.py +1 -1
  120. compute_api_client/models/team.py +1 -1
  121. compute_api_client/models/transaction.py +1 -1
  122. compute_api_client/models/user.py +1 -1
  123. compute_api_client/models/user_in.py +1 -1
  124. compute_api_client/models/validation_error.py +1 -1
  125. compute_api_client/rest.py +1 -1
  126. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.33.0.dist-info}/METADATA +20 -2
  127. qi_compute_api_client-0.33.0.dist-info/RECORD +180 -0
  128. qi_compute_api_client-0.32.0.dist-info/RECORD +0 -144
  129. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.33.0.dist-info}/LICENSE.md +0 -0
  130. {qi_compute_api_client-0.32.0.dist-info → qi_compute_api_client-0.33.0.dist-info}/WHEEL +0 -0
@@ -3,7 +3,7 @@
3
3
  """
4
4
  Quantum Inspire 2
5
5
 
6
- **Sorting and Pagination of list endpoints** The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list. - `latest` - **Type**: Boolean. - **Description**: Get the most recently created object. Defaults to False. - `sort_by` - **Type**: String: - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number` - **Type**: Positive Integer - **Description**: The page number for pagination. Defaults to 1. - `items_per_page` - **Type**: Positive Integer. - **Description**: The number of items per page for pagination. Defaults to 50.
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
7
 
8
8
  The version of the OpenAPI document: 0.1.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -23,6 +23,8 @@ 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
@@ -33,6 +35,7 @@ from compute_api_client.models.algorithm_type import AlgorithmType
33
35
  from compute_api_client.models.batch_job import BatchJob
34
36
  from compute_api_client.models.batch_job_in import BatchJobIn
35
37
  from compute_api_client.models.batch_job_status import BatchJobStatus
38
+ from compute_api_client.models.page_batch_job import PageBatchJob
36
39
 
37
40
  from compute_api_client.api_client import ApiClient
38
41
  from compute_api_client.api_response import ApiResponse
@@ -1399,10 +1402,6 @@ class BatchJobsApi:
1399
1402
  @validate_call
1400
1403
  async def read_batch_jobs_batch_jobs_get(
1401
1404
  self,
1402
- latest: Optional[StrictBool] = None,
1403
- sort_by: Optional[StrictStr] = None,
1404
- page_number: Optional[StrictInt] = None,
1405
- items_per_page: Optional[StrictInt] = None,
1406
1405
  id: Optional[StrictInt] = None,
1407
1406
  created_on: Optional[datetime] = None,
1408
1407
  status: Optional[BatchJobStatus] = None,
@@ -1416,6 +1415,10 @@ class BatchJobsApi:
1416
1415
  finished_at__isnull: Optional[StrictBool] = None,
1417
1416
  finished_at: Optional[datetime] = None,
1418
1417
  aggregated_algorithm_type: Optional[AlgorithmType] = None,
1418
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1419
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1420
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1421
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1419
1422
  _request_timeout: Union[
1420
1423
  None,
1421
1424
  Annotated[StrictFloat, Field(gt=0)],
@@ -1428,19 +1431,11 @@ class BatchJobsApi:
1428
1431
  _content_type: Optional[StrictStr] = None,
1429
1432
  _headers: Optional[Dict[StrictStr, Any]] = None,
1430
1433
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1431
- ) -> List[BatchJob]:
1434
+ ) -> PageBatchJob:
1432
1435
  """List batch jobs
1433
1436
 
1434
1437
  List batch jobs.
1435
1438
 
1436
- :param latest:
1437
- :type latest: bool
1438
- :param sort_by:
1439
- :type sort_by: str
1440
- :param page_number:
1441
- :type page_number: int
1442
- :param items_per_page:
1443
- :type items_per_page: int
1444
1439
  :param id:
1445
1440
  :type id: int
1446
1441
  :param created_on:
@@ -1467,6 +1462,14 @@ class BatchJobsApi:
1467
1462
  :type finished_at: datetime
1468
1463
  :param aggregated_algorithm_type:
1469
1464
  :type aggregated_algorithm_type: AlgorithmType
1465
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1466
+ :type sort_by: str
1467
+ :param latest: If True gets the most recently created object.
1468
+ :type latest: bool
1469
+ :param page: Page number
1470
+ :type page: int
1471
+ :param size: Page size
1472
+ :type size: int
1470
1473
  :param _request_timeout: timeout setting for this request. If one
1471
1474
  number provided, it will be total request
1472
1475
  timeout. It can also be a pair (tuple) of
@@ -1490,10 +1493,6 @@ class BatchJobsApi:
1490
1493
  """ # noqa: E501
1491
1494
 
1492
1495
  _param = self._read_batch_jobs_batch_jobs_get_serialize(
1493
- latest=latest,
1494
- sort_by=sort_by,
1495
- page_number=page_number,
1496
- items_per_page=items_per_page,
1497
1496
  id=id,
1498
1497
  created_on=created_on,
1499
1498
  status=status,
@@ -1507,6 +1506,10 @@ class BatchJobsApi:
1507
1506
  finished_at__isnull=finished_at__isnull,
1508
1507
  finished_at=finished_at,
1509
1508
  aggregated_algorithm_type=aggregated_algorithm_type,
1509
+ sort_by=sort_by,
1510
+ latest=latest,
1511
+ page=page,
1512
+ size=size,
1510
1513
  _request_auth=_request_auth,
1511
1514
  _content_type=_content_type,
1512
1515
  _headers=_headers,
@@ -1514,7 +1517,7 @@ class BatchJobsApi:
1514
1517
  )
1515
1518
 
1516
1519
  _response_types_map: Dict[str, Optional[str]] = {
1517
- '200': "List[BatchJob]",
1520
+ '200': "PageBatchJob",
1518
1521
  '422': "HTTPValidationError"
1519
1522
 
1520
1523
  }
@@ -1532,10 +1535,6 @@ class BatchJobsApi:
1532
1535
  @validate_call
1533
1536
  async def read_batch_jobs_batch_jobs_get_with_http_info(
1534
1537
  self,
1535
- latest: Optional[StrictBool] = None,
1536
- sort_by: Optional[StrictStr] = None,
1537
- page_number: Optional[StrictInt] = None,
1538
- items_per_page: Optional[StrictInt] = None,
1539
1538
  id: Optional[StrictInt] = None,
1540
1539
  created_on: Optional[datetime] = None,
1541
1540
  status: Optional[BatchJobStatus] = None,
@@ -1549,6 +1548,10 @@ class BatchJobsApi:
1549
1548
  finished_at__isnull: Optional[StrictBool] = None,
1550
1549
  finished_at: Optional[datetime] = None,
1551
1550
  aggregated_algorithm_type: Optional[AlgorithmType] = None,
1551
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1552
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1553
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1554
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1552
1555
  _request_timeout: Union[
1553
1556
  None,
1554
1557
  Annotated[StrictFloat, Field(gt=0)],
@@ -1561,19 +1564,11 @@ class BatchJobsApi:
1561
1564
  _content_type: Optional[StrictStr] = None,
1562
1565
  _headers: Optional[Dict[StrictStr, Any]] = None,
1563
1566
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1564
- ) -> ApiResponse[List[BatchJob]]:
1567
+ ) -> ApiResponse[PageBatchJob]:
1565
1568
  """List batch jobs
1566
1569
 
1567
1570
  List batch jobs.
1568
1571
 
1569
- :param latest:
1570
- :type latest: bool
1571
- :param sort_by:
1572
- :type sort_by: str
1573
- :param page_number:
1574
- :type page_number: int
1575
- :param items_per_page:
1576
- :type items_per_page: int
1577
1572
  :param id:
1578
1573
  :type id: int
1579
1574
  :param created_on:
@@ -1600,6 +1595,14 @@ class BatchJobsApi:
1600
1595
  :type finished_at: datetime
1601
1596
  :param aggregated_algorithm_type:
1602
1597
  :type aggregated_algorithm_type: AlgorithmType
1598
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1599
+ :type sort_by: str
1600
+ :param latest: If True gets the most recently created object.
1601
+ :type latest: bool
1602
+ :param page: Page number
1603
+ :type page: int
1604
+ :param size: Page size
1605
+ :type size: int
1603
1606
  :param _request_timeout: timeout setting for this request. If one
1604
1607
  number provided, it will be total request
1605
1608
  timeout. It can also be a pair (tuple) of
@@ -1623,10 +1626,6 @@ class BatchJobsApi:
1623
1626
  """ # noqa: E501
1624
1627
 
1625
1628
  _param = self._read_batch_jobs_batch_jobs_get_serialize(
1626
- latest=latest,
1627
- sort_by=sort_by,
1628
- page_number=page_number,
1629
- items_per_page=items_per_page,
1630
1629
  id=id,
1631
1630
  created_on=created_on,
1632
1631
  status=status,
@@ -1640,6 +1639,10 @@ class BatchJobsApi:
1640
1639
  finished_at__isnull=finished_at__isnull,
1641
1640
  finished_at=finished_at,
1642
1641
  aggregated_algorithm_type=aggregated_algorithm_type,
1642
+ sort_by=sort_by,
1643
+ latest=latest,
1644
+ page=page,
1645
+ size=size,
1643
1646
  _request_auth=_request_auth,
1644
1647
  _content_type=_content_type,
1645
1648
  _headers=_headers,
@@ -1647,7 +1650,7 @@ class BatchJobsApi:
1647
1650
  )
1648
1651
 
1649
1652
  _response_types_map: Dict[str, Optional[str]] = {
1650
- '200': "List[BatchJob]",
1653
+ '200': "PageBatchJob",
1651
1654
  '422': "HTTPValidationError"
1652
1655
 
1653
1656
  }
@@ -1665,10 +1668,6 @@ class BatchJobsApi:
1665
1668
  @validate_call
1666
1669
  async def read_batch_jobs_batch_jobs_get_without_preload_content(
1667
1670
  self,
1668
- latest: Optional[StrictBool] = None,
1669
- sort_by: Optional[StrictStr] = None,
1670
- page_number: Optional[StrictInt] = None,
1671
- items_per_page: Optional[StrictInt] = None,
1672
1671
  id: Optional[StrictInt] = None,
1673
1672
  created_on: Optional[datetime] = None,
1674
1673
  status: Optional[BatchJobStatus] = None,
@@ -1682,6 +1681,10 @@ class BatchJobsApi:
1682
1681
  finished_at__isnull: Optional[StrictBool] = None,
1683
1682
  finished_at: Optional[datetime] = None,
1684
1683
  aggregated_algorithm_type: Optional[AlgorithmType] = None,
1684
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1685
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1686
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1687
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1685
1688
  _request_timeout: Union[
1686
1689
  None,
1687
1690
  Annotated[StrictFloat, Field(gt=0)],
@@ -1699,14 +1702,6 @@ class BatchJobsApi:
1699
1702
 
1700
1703
  List batch jobs.
1701
1704
 
1702
- :param latest:
1703
- :type latest: bool
1704
- :param sort_by:
1705
- :type sort_by: str
1706
- :param page_number:
1707
- :type page_number: int
1708
- :param items_per_page:
1709
- :type items_per_page: int
1710
1705
  :param id:
1711
1706
  :type id: int
1712
1707
  :param created_on:
@@ -1733,6 +1728,14 @@ class BatchJobsApi:
1733
1728
  :type finished_at: datetime
1734
1729
  :param aggregated_algorithm_type:
1735
1730
  :type aggregated_algorithm_type: AlgorithmType
1731
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1732
+ :type sort_by: str
1733
+ :param latest: If True gets the most recently created object.
1734
+ :type latest: bool
1735
+ :param page: Page number
1736
+ :type page: int
1737
+ :param size: Page size
1738
+ :type size: int
1736
1739
  :param _request_timeout: timeout setting for this request. If one
1737
1740
  number provided, it will be total request
1738
1741
  timeout. It can also be a pair (tuple) of
@@ -1756,10 +1759,6 @@ class BatchJobsApi:
1756
1759
  """ # noqa: E501
1757
1760
 
1758
1761
  _param = self._read_batch_jobs_batch_jobs_get_serialize(
1759
- latest=latest,
1760
- sort_by=sort_by,
1761
- page_number=page_number,
1762
- items_per_page=items_per_page,
1763
1762
  id=id,
1764
1763
  created_on=created_on,
1765
1764
  status=status,
@@ -1773,6 +1772,10 @@ class BatchJobsApi:
1773
1772
  finished_at__isnull=finished_at__isnull,
1774
1773
  finished_at=finished_at,
1775
1774
  aggregated_algorithm_type=aggregated_algorithm_type,
1775
+ sort_by=sort_by,
1776
+ latest=latest,
1777
+ page=page,
1778
+ size=size,
1776
1779
  _request_auth=_request_auth,
1777
1780
  _content_type=_content_type,
1778
1781
  _headers=_headers,
@@ -1780,7 +1783,7 @@ class BatchJobsApi:
1780
1783
  )
1781
1784
 
1782
1785
  _response_types_map: Dict[str, Optional[str]] = {
1783
- '200': "List[BatchJob]",
1786
+ '200': "PageBatchJob",
1784
1787
  '422': "HTTPValidationError"
1785
1788
 
1786
1789
  }
@@ -1793,10 +1796,6 @@ class BatchJobsApi:
1793
1796
 
1794
1797
  def _read_batch_jobs_batch_jobs_get_serialize(
1795
1798
  self,
1796
- latest,
1797
- sort_by,
1798
- page_number,
1799
- items_per_page,
1800
1799
  id,
1801
1800
  created_on,
1802
1801
  status,
@@ -1810,6 +1809,10 @@ class BatchJobsApi:
1810
1809
  finished_at__isnull,
1811
1810
  finished_at,
1812
1811
  aggregated_algorithm_type,
1812
+ sort_by,
1813
+ latest,
1814
+ page,
1815
+ size,
1813
1816
  _request_auth,
1814
1817
  _content_type,
1815
1818
  _headers,
@@ -1831,22 +1834,6 @@ class BatchJobsApi:
1831
1834
 
1832
1835
  # process the path parameters
1833
1836
  # process the query parameters
1834
- if latest is not None:
1835
-
1836
- _query_params.append(('latest', latest))
1837
-
1838
- if sort_by is not None:
1839
-
1840
- _query_params.append(('sort_by', sort_by))
1841
-
1842
- if page_number is not None:
1843
-
1844
- _query_params.append(('page_number', page_number))
1845
-
1846
- if items_per_page is not None:
1847
-
1848
- _query_params.append(('items_per_page', items_per_page))
1849
-
1850
1837
  if id is not None:
1851
1838
 
1852
1839
  _query_params.append(('id', id))
@@ -1935,6 +1922,22 @@ class BatchJobsApi:
1935
1922
 
1936
1923
  _query_params.append(('aggregated_algorithm_type', aggregated_algorithm_type.value))
1937
1924
 
1925
+ if sort_by is not None:
1926
+
1927
+ _query_params.append(('sort_by', sort_by))
1928
+
1929
+ if latest is not None:
1930
+
1931
+ _query_params.append(('latest', latest))
1932
+
1933
+ if page is not None:
1934
+
1935
+ _query_params.append(('page', page))
1936
+
1937
+ if size is not None:
1938
+
1939
+ _query_params.append(('size', size))
1940
+
1938
1941
  # process the header parameters
1939
1942
  # process the form parameters
1940
1943
  # 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,14 +23,17 @@ 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
 
32
34
  from compute_api_client.models.commit import Commit
33
35
  from compute_api_client.models.commit_in import CommitIn
36
+ from compute_api_client.models.page_commit import PageCommit
34
37
 
35
38
  from compute_api_client.api_client import ApiClient
36
39
  from compute_api_client.api_response import ApiResponse
@@ -859,15 +862,15 @@ class CommitsApi:
859
862
  @validate_call
860
863
  async def read_commits_commits_get(
861
864
  self,
862
- latest: Optional[StrictBool] = None,
863
- sort_by: Optional[StrictStr] = None,
864
- page_number: Optional[StrictInt] = None,
865
- items_per_page: Optional[StrictInt] = None,
866
865
  id: Optional[StrictInt] = None,
867
866
  created_on: Optional[datetime] = None,
868
867
  hash: Optional[StrictStr] = None,
869
868
  description: Optional[StrictStr] = None,
870
869
  algorithm_id: Optional[StrictInt] = None,
870
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
871
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
872
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
873
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
871
874
  _request_timeout: Union[
872
875
  None,
873
876
  Annotated[StrictFloat, Field(gt=0)],
@@ -880,19 +883,11 @@ class CommitsApi:
880
883
  _content_type: Optional[StrictStr] = None,
881
884
  _headers: Optional[Dict[StrictStr, Any]] = None,
882
885
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
883
- ) -> List[Commit]:
886
+ ) -> PageCommit:
884
887
  """List commits
885
888
 
886
889
  List commits.
887
890
 
888
- :param latest:
889
- :type latest: bool
890
- :param sort_by:
891
- :type sort_by: str
892
- :param page_number:
893
- :type page_number: int
894
- :param items_per_page:
895
- :type items_per_page: int
896
891
  :param id:
897
892
  :type id: int
898
893
  :param created_on:
@@ -903,6 +898,14 @@ class CommitsApi:
903
898
  :type description: str
904
899
  :param algorithm_id:
905
900
  :type algorithm_id: int
901
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
902
+ :type sort_by: str
903
+ :param latest: If True gets the most recently created object.
904
+ :type latest: bool
905
+ :param page: Page number
906
+ :type page: int
907
+ :param size: Page size
908
+ :type size: int
906
909
  :param _request_timeout: timeout setting for this request. If one
907
910
  number provided, it will be total request
908
911
  timeout. It can also be a pair (tuple) of
@@ -926,15 +929,15 @@ class CommitsApi:
926
929
  """ # noqa: E501
927
930
 
928
931
  _param = self._read_commits_commits_get_serialize(
929
- latest=latest,
930
- sort_by=sort_by,
931
- page_number=page_number,
932
- items_per_page=items_per_page,
933
932
  id=id,
934
933
  created_on=created_on,
935
934
  hash=hash,
936
935
  description=description,
937
936
  algorithm_id=algorithm_id,
937
+ sort_by=sort_by,
938
+ latest=latest,
939
+ page=page,
940
+ size=size,
938
941
  _request_auth=_request_auth,
939
942
  _content_type=_content_type,
940
943
  _headers=_headers,
@@ -942,7 +945,7 @@ class CommitsApi:
942
945
  )
943
946
 
944
947
  _response_types_map: Dict[str, Optional[str]] = {
945
- '200': "List[Commit]",
948
+ '200': "PageCommit",
946
949
  '422': "HTTPValidationError"
947
950
 
948
951
  }
@@ -960,15 +963,15 @@ class CommitsApi:
960
963
  @validate_call
961
964
  async def read_commits_commits_get_with_http_info(
962
965
  self,
963
- latest: Optional[StrictBool] = None,
964
- sort_by: Optional[StrictStr] = None,
965
- page_number: Optional[StrictInt] = None,
966
- items_per_page: Optional[StrictInt] = None,
967
966
  id: Optional[StrictInt] = None,
968
967
  created_on: Optional[datetime] = None,
969
968
  hash: Optional[StrictStr] = None,
970
969
  description: Optional[StrictStr] = None,
971
970
  algorithm_id: Optional[StrictInt] = None,
971
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
972
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
973
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
974
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
972
975
  _request_timeout: Union[
973
976
  None,
974
977
  Annotated[StrictFloat, Field(gt=0)],
@@ -981,19 +984,11 @@ class CommitsApi:
981
984
  _content_type: Optional[StrictStr] = None,
982
985
  _headers: Optional[Dict[StrictStr, Any]] = None,
983
986
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
984
- ) -> ApiResponse[List[Commit]]:
987
+ ) -> ApiResponse[PageCommit]:
985
988
  """List commits
986
989
 
987
990
  List commits.
988
991
 
989
- :param latest:
990
- :type latest: bool
991
- :param sort_by:
992
- :type sort_by: str
993
- :param page_number:
994
- :type page_number: int
995
- :param items_per_page:
996
- :type items_per_page: int
997
992
  :param id:
998
993
  :type id: int
999
994
  :param created_on:
@@ -1004,6 +999,14 @@ class CommitsApi:
1004
999
  :type description: str
1005
1000
  :param algorithm_id:
1006
1001
  :type algorithm_id: int
1002
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1003
+ :type sort_by: str
1004
+ :param latest: If True gets the most recently created object.
1005
+ :type latest: bool
1006
+ :param page: Page number
1007
+ :type page: int
1008
+ :param size: Page size
1009
+ :type size: int
1007
1010
  :param _request_timeout: timeout setting for this request. If one
1008
1011
  number provided, it will be total request
1009
1012
  timeout. It can also be a pair (tuple) of
@@ -1027,15 +1030,15 @@ class CommitsApi:
1027
1030
  """ # noqa: E501
1028
1031
 
1029
1032
  _param = self._read_commits_commits_get_serialize(
1030
- latest=latest,
1031
- sort_by=sort_by,
1032
- page_number=page_number,
1033
- items_per_page=items_per_page,
1034
1033
  id=id,
1035
1034
  created_on=created_on,
1036
1035
  hash=hash,
1037
1036
  description=description,
1038
1037
  algorithm_id=algorithm_id,
1038
+ sort_by=sort_by,
1039
+ latest=latest,
1040
+ page=page,
1041
+ size=size,
1039
1042
  _request_auth=_request_auth,
1040
1043
  _content_type=_content_type,
1041
1044
  _headers=_headers,
@@ -1043,7 +1046,7 @@ class CommitsApi:
1043
1046
  )
1044
1047
 
1045
1048
  _response_types_map: Dict[str, Optional[str]] = {
1046
- '200': "List[Commit]",
1049
+ '200': "PageCommit",
1047
1050
  '422': "HTTPValidationError"
1048
1051
 
1049
1052
  }
@@ -1061,15 +1064,15 @@ class CommitsApi:
1061
1064
  @validate_call
1062
1065
  async def read_commits_commits_get_without_preload_content(
1063
1066
  self,
1064
- latest: Optional[StrictBool] = None,
1065
- sort_by: Optional[StrictStr] = None,
1066
- page_number: Optional[StrictInt] = None,
1067
- items_per_page: Optional[StrictInt] = None,
1068
1067
  id: Optional[StrictInt] = None,
1069
1068
  created_on: Optional[datetime] = None,
1070
1069
  hash: Optional[StrictStr] = None,
1071
1070
  description: Optional[StrictStr] = None,
1072
1071
  algorithm_id: Optional[StrictInt] = None,
1072
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1073
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1074
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1075
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1073
1076
  _request_timeout: Union[
1074
1077
  None,
1075
1078
  Annotated[StrictFloat, Field(gt=0)],
@@ -1087,14 +1090,6 @@ class CommitsApi:
1087
1090
 
1088
1091
  List commits.
1089
1092
 
1090
- :param latest:
1091
- :type latest: bool
1092
- :param sort_by:
1093
- :type sort_by: str
1094
- :param page_number:
1095
- :type page_number: int
1096
- :param items_per_page:
1097
- :type items_per_page: int
1098
1093
  :param id:
1099
1094
  :type id: int
1100
1095
  :param created_on:
@@ -1105,6 +1100,14 @@ class CommitsApi:
1105
1100
  :type description: str
1106
1101
  :param algorithm_id:
1107
1102
  :type algorithm_id: int
1103
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1104
+ :type sort_by: str
1105
+ :param latest: If True gets the most recently created object.
1106
+ :type latest: bool
1107
+ :param page: Page number
1108
+ :type page: int
1109
+ :param size: Page size
1110
+ :type size: int
1108
1111
  :param _request_timeout: timeout setting for this request. If one
1109
1112
  number provided, it will be total request
1110
1113
  timeout. It can also be a pair (tuple) of
@@ -1128,15 +1131,15 @@ class CommitsApi:
1128
1131
  """ # noqa: E501
1129
1132
 
1130
1133
  _param = self._read_commits_commits_get_serialize(
1131
- latest=latest,
1132
- sort_by=sort_by,
1133
- page_number=page_number,
1134
- items_per_page=items_per_page,
1135
1134
  id=id,
1136
1135
  created_on=created_on,
1137
1136
  hash=hash,
1138
1137
  description=description,
1139
1138
  algorithm_id=algorithm_id,
1139
+ sort_by=sort_by,
1140
+ latest=latest,
1141
+ page=page,
1142
+ size=size,
1140
1143
  _request_auth=_request_auth,
1141
1144
  _content_type=_content_type,
1142
1145
  _headers=_headers,
@@ -1144,7 +1147,7 @@ class CommitsApi:
1144
1147
  )
1145
1148
 
1146
1149
  _response_types_map: Dict[str, Optional[str]] = {
1147
- '200': "List[Commit]",
1150
+ '200': "PageCommit",
1148
1151
  '422': "HTTPValidationError"
1149
1152
 
1150
1153
  }
@@ -1157,15 +1160,15 @@ class CommitsApi:
1157
1160
 
1158
1161
  def _read_commits_commits_get_serialize(
1159
1162
  self,
1160
- latest,
1161
- sort_by,
1162
- page_number,
1163
- items_per_page,
1164
1163
  id,
1165
1164
  created_on,
1166
1165
  hash,
1167
1166
  description,
1168
1167
  algorithm_id,
1168
+ sort_by,
1169
+ latest,
1170
+ page,
1171
+ size,
1169
1172
  _request_auth,
1170
1173
  _content_type,
1171
1174
  _headers,
@@ -1187,22 +1190,6 @@ class CommitsApi:
1187
1190
 
1188
1191
  # process the path parameters
1189
1192
  # process the query parameters
1190
- if latest is not None:
1191
-
1192
- _query_params.append(('latest', latest))
1193
-
1194
- if sort_by is not None:
1195
-
1196
- _query_params.append(('sort_by', sort_by))
1197
-
1198
- if page_number is not None:
1199
-
1200
- _query_params.append(('page_number', page_number))
1201
-
1202
- if items_per_page is not None:
1203
-
1204
- _query_params.append(('items_per_page', items_per_page))
1205
-
1206
1193
  if id is not None:
1207
1194
 
1208
1195
  _query_params.append(('id', id))
@@ -1232,6 +1219,22 @@ class CommitsApi:
1232
1219
 
1233
1220
  _query_params.append(('algorithm_id', algorithm_id))
1234
1221
 
1222
+ if sort_by is not None:
1223
+
1224
+ _query_params.append(('sort_by', sort_by))
1225
+
1226
+ if latest is not None:
1227
+
1228
+ _query_params.append(('latest', latest))
1229
+
1230
+ if page is not None:
1231
+
1232
+ _query_params.append(('page', page))
1233
+
1234
+ if size is not None:
1235
+
1236
+ _query_params.append(('size', size))
1237
+
1235
1238
  # process the header parameters
1236
1239
  # process the form parameters
1237
1240
  # process the body parameter