qi-compute-api-client 0.31.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 (132) 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 -97
  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/Result.md +0 -1
  54. compute_api_client/docs/ResultIn.md +0 -1
  55. compute_api_client/docs/ResultsApi.md +24 -18
  56. compute_api_client/docs/TeamsApi.md +12 -12
  57. compute_api_client/docs/TransactionsApi.md +12 -12
  58. compute_api_client/docs/UsersApi.md +12 -12
  59. compute_api_client/exceptions.py +1 -1
  60. compute_api_client/models/__init__.py +19 -1
  61. compute_api_client/models/algorithm.py +1 -1
  62. compute_api_client/models/algorithm_in.py +1 -1
  63. compute_api_client/models/algorithm_type.py +1 -1
  64. compute_api_client/models/backend.py +1 -1
  65. compute_api_client/models/backend_in.py +1 -1
  66. compute_api_client/models/backend_patch.py +1 -1
  67. compute_api_client/models/backend_status.py +1 -1
  68. compute_api_client/models/backend_type.py +1 -1
  69. compute_api_client/models/backend_with_authentication.py +1 -1
  70. compute_api_client/models/batch_job.py +1 -1
  71. compute_api_client/models/batch_job_in.py +1 -1
  72. compute_api_client/models/batch_job_status.py +1 -1
  73. compute_api_client/models/commit.py +1 -1
  74. compute_api_client/models/commit_in.py +1 -1
  75. compute_api_client/models/compile_stage.py +1 -1
  76. compute_api_client/models/domain.py +1 -1
  77. compute_api_client/models/file.py +1 -1
  78. compute_api_client/models/file_in.py +1 -1
  79. compute_api_client/models/final_result.py +1 -1
  80. compute_api_client/models/final_result_in.py +1 -1
  81. compute_api_client/models/http_not_found_error.py +1 -1
  82. compute_api_client/models/http_validation_error.py +1 -1
  83. compute_api_client/models/job.py +1 -1
  84. compute_api_client/models/job_in.py +1 -1
  85. compute_api_client/models/job_patch.py +1 -1
  86. compute_api_client/models/job_status.py +1 -1
  87. compute_api_client/models/language.py +1 -1
  88. compute_api_client/models/location_inner.py +1 -1
  89. compute_api_client/models/member.py +1 -1
  90. compute_api_client/models/member_in.py +1 -1
  91. compute_api_client/models/metadata.py +1 -1
  92. compute_api_client/models/metadata_in.py +1 -1
  93. compute_api_client/models/page_algorithm.py +125 -0
  94. compute_api_client/models/page_backend.py +125 -0
  95. compute_api_client/models/page_backend_type.py +125 -0
  96. compute_api_client/models/page_batch_job.py +125 -0
  97. compute_api_client/models/page_commit.py +125 -0
  98. compute_api_client/models/page_file.py +125 -0
  99. compute_api_client/models/page_job.py +125 -0
  100. compute_api_client/models/page_language.py +125 -0
  101. compute_api_client/models/page_member.py +125 -0
  102. compute_api_client/models/page_metadata.py +125 -0
  103. compute_api_client/models/page_permission.py +125 -0
  104. compute_api_client/models/page_permission_group.py +125 -0
  105. compute_api_client/models/page_project.py +125 -0
  106. compute_api_client/models/page_reservation.py +125 -0
  107. compute_api_client/models/page_result.py +125 -0
  108. compute_api_client/models/page_team.py +125 -0
  109. compute_api_client/models/page_transaction.py +125 -0
  110. compute_api_client/models/page_user.py +125 -0
  111. compute_api_client/models/permission.py +1 -1
  112. compute_api_client/models/permission_group.py +1 -1
  113. compute_api_client/models/project.py +1 -1
  114. compute_api_client/models/project_in.py +1 -1
  115. compute_api_client/models/project_patch.py +1 -1
  116. compute_api_client/models/reservation.py +1 -1
  117. compute_api_client/models/reservation_in.py +1 -1
  118. compute_api_client/models/result.py +2 -6
  119. compute_api_client/models/result_in.py +2 -6
  120. compute_api_client/models/role.py +1 -1
  121. compute_api_client/models/share_type.py +1 -1
  122. compute_api_client/models/team.py +1 -1
  123. compute_api_client/models/transaction.py +1 -1
  124. compute_api_client/models/user.py +1 -1
  125. compute_api_client/models/user_in.py +1 -1
  126. compute_api_client/models/validation_error.py +1 -1
  127. compute_api_client/rest.py +1 -1
  128. {qi_compute_api_client-0.31.0.dist-info → qi_compute_api_client-0.33.0.dist-info}/METADATA +20 -2
  129. qi_compute_api_client-0.33.0.dist-info/RECORD +180 -0
  130. {qi_compute_api_client-0.31.0.dist-info → qi_compute_api_client-0.33.0.dist-info}/WHEEL +1 -1
  131. qi_compute_api_client-0.31.0.dist-info/RECORD +0 -144
  132. {qi_compute_api_client-0.31.0.dist-info → qi_compute_api_client-0.33.0.dist-info}/LICENSE.md +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,17 +23,20 @@ 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.backend import Backend
33
35
  from compute_api_client.models.backend_in import BackendIn
34
36
  from compute_api_client.models.backend_patch import BackendPatch
35
37
  from compute_api_client.models.backend_status import BackendStatus
36
38
  from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
39
+ from compute_api_client.models.page_backend import PageBackend
37
40
 
38
41
  from compute_api_client.api_client import ApiClient
39
42
  from compute_api_client.api_response import ApiResponse
@@ -849,16 +852,16 @@ class BackendApi:
849
852
  @validate_call
850
853
  async def read_backends_backends_get(
851
854
  self,
852
- latest: Optional[StrictBool] = None,
853
- sort_by: Optional[StrictStr] = None,
854
- page_number: Optional[StrictInt] = None,
855
- items_per_page: Optional[StrictInt] = None,
856
855
  id: Optional[StrictInt] = None,
857
856
  name: Optional[StrictStr] = None,
858
857
  location: Optional[StrictStr] = None,
859
858
  backend_type_id: Optional[StrictInt] = None,
860
859
  status: Optional[BackendStatus] = None,
861
860
  last_heartbeat: Optional[datetime] = None,
861
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
862
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
863
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
864
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
862
865
  _request_timeout: Union[
863
866
  None,
864
867
  Annotated[StrictFloat, Field(gt=0)],
@@ -871,19 +874,11 @@ class BackendApi:
871
874
  _content_type: Optional[StrictStr] = None,
872
875
  _headers: Optional[Dict[StrictStr, Any]] = None,
873
876
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
874
- ) -> List[Backend]:
877
+ ) -> PageBackend:
875
878
  """List backends
876
879
 
877
880
  Read backends.
878
881
 
879
- :param latest:
880
- :type latest: bool
881
- :param sort_by:
882
- :type sort_by: str
883
- :param page_number:
884
- :type page_number: int
885
- :param items_per_page:
886
- :type items_per_page: int
887
882
  :param id:
888
883
  :type id: int
889
884
  :param name:
@@ -896,6 +891,14 @@ class BackendApi:
896
891
  :type status: BackendStatus
897
892
  :param last_heartbeat:
898
893
  :type last_heartbeat: datetime
894
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
895
+ :type sort_by: str
896
+ :param latest: If True gets the most recently created object.
897
+ :type latest: bool
898
+ :param page: Page number
899
+ :type page: int
900
+ :param size: Page size
901
+ :type size: int
899
902
  :param _request_timeout: timeout setting for this request. If one
900
903
  number provided, it will be total request
901
904
  timeout. It can also be a pair (tuple) of
@@ -919,16 +922,16 @@ class BackendApi:
919
922
  """ # noqa: E501
920
923
 
921
924
  _param = self._read_backends_backends_get_serialize(
922
- latest=latest,
923
- sort_by=sort_by,
924
- page_number=page_number,
925
- items_per_page=items_per_page,
926
925
  id=id,
927
926
  name=name,
928
927
  location=location,
929
928
  backend_type_id=backend_type_id,
930
929
  status=status,
931
930
  last_heartbeat=last_heartbeat,
931
+ sort_by=sort_by,
932
+ latest=latest,
933
+ page=page,
934
+ size=size,
932
935
  _request_auth=_request_auth,
933
936
  _content_type=_content_type,
934
937
  _headers=_headers,
@@ -936,7 +939,7 @@ class BackendApi:
936
939
  )
937
940
 
938
941
  _response_types_map: Dict[str, Optional[str]] = {
939
- '200': "List[Backend]",
942
+ '200': "PageBackend",
940
943
  '422': "HTTPValidationError"
941
944
 
942
945
  }
@@ -954,16 +957,16 @@ class BackendApi:
954
957
  @validate_call
955
958
  async def read_backends_backends_get_with_http_info(
956
959
  self,
957
- latest: Optional[StrictBool] = None,
958
- sort_by: Optional[StrictStr] = None,
959
- page_number: Optional[StrictInt] = None,
960
- items_per_page: Optional[StrictInt] = None,
961
960
  id: Optional[StrictInt] = None,
962
961
  name: Optional[StrictStr] = None,
963
962
  location: Optional[StrictStr] = None,
964
963
  backend_type_id: Optional[StrictInt] = None,
965
964
  status: Optional[BackendStatus] = None,
966
965
  last_heartbeat: Optional[datetime] = None,
966
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
967
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
968
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
969
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
967
970
  _request_timeout: Union[
968
971
  None,
969
972
  Annotated[StrictFloat, Field(gt=0)],
@@ -976,19 +979,11 @@ class BackendApi:
976
979
  _content_type: Optional[StrictStr] = None,
977
980
  _headers: Optional[Dict[StrictStr, Any]] = None,
978
981
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
979
- ) -> ApiResponse[List[Backend]]:
982
+ ) -> ApiResponse[PageBackend]:
980
983
  """List backends
981
984
 
982
985
  Read backends.
983
986
 
984
- :param latest:
985
- :type latest: bool
986
- :param sort_by:
987
- :type sort_by: str
988
- :param page_number:
989
- :type page_number: int
990
- :param items_per_page:
991
- :type items_per_page: int
992
987
  :param id:
993
988
  :type id: int
994
989
  :param name:
@@ -1001,6 +996,14 @@ class BackendApi:
1001
996
  :type status: BackendStatus
1002
997
  :param last_heartbeat:
1003
998
  :type last_heartbeat: datetime
999
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1000
+ :type sort_by: str
1001
+ :param latest: If True gets the most recently created object.
1002
+ :type latest: bool
1003
+ :param page: Page number
1004
+ :type page: int
1005
+ :param size: Page size
1006
+ :type size: int
1004
1007
  :param _request_timeout: timeout setting for this request. If one
1005
1008
  number provided, it will be total request
1006
1009
  timeout. It can also be a pair (tuple) of
@@ -1024,16 +1027,16 @@ class BackendApi:
1024
1027
  """ # noqa: E501
1025
1028
 
1026
1029
  _param = self._read_backends_backends_get_serialize(
1027
- latest=latest,
1028
- sort_by=sort_by,
1029
- page_number=page_number,
1030
- items_per_page=items_per_page,
1031
1030
  id=id,
1032
1031
  name=name,
1033
1032
  location=location,
1034
1033
  backend_type_id=backend_type_id,
1035
1034
  status=status,
1036
1035
  last_heartbeat=last_heartbeat,
1036
+ sort_by=sort_by,
1037
+ latest=latest,
1038
+ page=page,
1039
+ size=size,
1037
1040
  _request_auth=_request_auth,
1038
1041
  _content_type=_content_type,
1039
1042
  _headers=_headers,
@@ -1041,7 +1044,7 @@ class BackendApi:
1041
1044
  )
1042
1045
 
1043
1046
  _response_types_map: Dict[str, Optional[str]] = {
1044
- '200': "List[Backend]",
1047
+ '200': "PageBackend",
1045
1048
  '422': "HTTPValidationError"
1046
1049
 
1047
1050
  }
@@ -1059,16 +1062,16 @@ class BackendApi:
1059
1062
  @validate_call
1060
1063
  async def read_backends_backends_get_without_preload_content(
1061
1064
  self,
1062
- latest: Optional[StrictBool] = None,
1063
- sort_by: Optional[StrictStr] = None,
1064
- page_number: Optional[StrictInt] = None,
1065
- items_per_page: Optional[StrictInt] = None,
1066
1065
  id: Optional[StrictInt] = None,
1067
1066
  name: Optional[StrictStr] = None,
1068
1067
  location: Optional[StrictStr] = None,
1069
1068
  backend_type_id: Optional[StrictInt] = None,
1070
1069
  status: Optional[BackendStatus] = None,
1071
1070
  last_heartbeat: Optional[datetime] = None,
1071
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
1072
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
1073
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
1074
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
1072
1075
  _request_timeout: Union[
1073
1076
  None,
1074
1077
  Annotated[StrictFloat, Field(gt=0)],
@@ -1086,14 +1089,6 @@ class BackendApi:
1086
1089
 
1087
1090
  Read backends.
1088
1091
 
1089
- :param latest:
1090
- :type latest: bool
1091
- :param sort_by:
1092
- :type sort_by: str
1093
- :param page_number:
1094
- :type page_number: int
1095
- :param items_per_page:
1096
- :type items_per_page: int
1097
1092
  :param id:
1098
1093
  :type id: int
1099
1094
  :param name:
@@ -1106,6 +1101,14 @@ class BackendApi:
1106
1101
  :type status: BackendStatus
1107
1102
  :param last_heartbeat:
1108
1103
  :type last_heartbeat: datetime
1104
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
1105
+ :type sort_by: str
1106
+ :param latest: If True gets the most recently created object.
1107
+ :type latest: bool
1108
+ :param page: Page number
1109
+ :type page: int
1110
+ :param size: Page size
1111
+ :type size: int
1109
1112
  :param _request_timeout: timeout setting for this request. If one
1110
1113
  number provided, it will be total request
1111
1114
  timeout. It can also be a pair (tuple) of
@@ -1129,16 +1132,16 @@ class BackendApi:
1129
1132
  """ # noqa: E501
1130
1133
 
1131
1134
  _param = self._read_backends_backends_get_serialize(
1132
- latest=latest,
1133
- sort_by=sort_by,
1134
- page_number=page_number,
1135
- items_per_page=items_per_page,
1136
1135
  id=id,
1137
1136
  name=name,
1138
1137
  location=location,
1139
1138
  backend_type_id=backend_type_id,
1140
1139
  status=status,
1141
1140
  last_heartbeat=last_heartbeat,
1141
+ sort_by=sort_by,
1142
+ latest=latest,
1143
+ page=page,
1144
+ size=size,
1142
1145
  _request_auth=_request_auth,
1143
1146
  _content_type=_content_type,
1144
1147
  _headers=_headers,
@@ -1146,7 +1149,7 @@ class BackendApi:
1146
1149
  )
1147
1150
 
1148
1151
  _response_types_map: Dict[str, Optional[str]] = {
1149
- '200': "List[Backend]",
1152
+ '200': "PageBackend",
1150
1153
  '422': "HTTPValidationError"
1151
1154
 
1152
1155
  }
@@ -1159,16 +1162,16 @@ class BackendApi:
1159
1162
 
1160
1163
  def _read_backends_backends_get_serialize(
1161
1164
  self,
1162
- latest,
1163
- sort_by,
1164
- page_number,
1165
- items_per_page,
1166
1165
  id,
1167
1166
  name,
1168
1167
  location,
1169
1168
  backend_type_id,
1170
1169
  status,
1171
1170
  last_heartbeat,
1171
+ sort_by,
1172
+ latest,
1173
+ page,
1174
+ size,
1172
1175
  _request_auth,
1173
1176
  _content_type,
1174
1177
  _headers,
@@ -1190,22 +1193,6 @@ class BackendApi:
1190
1193
 
1191
1194
  # process the path parameters
1192
1195
  # process the query parameters
1193
- if latest is not None:
1194
-
1195
- _query_params.append(('latest', latest))
1196
-
1197
- if sort_by is not None:
1198
-
1199
- _query_params.append(('sort_by', sort_by))
1200
-
1201
- if page_number is not None:
1202
-
1203
- _query_params.append(('page_number', page_number))
1204
-
1205
- if items_per_page is not None:
1206
-
1207
- _query_params.append(('items_per_page', items_per_page))
1208
-
1209
1196
  if id is not None:
1210
1197
 
1211
1198
  _query_params.append(('id', id))
@@ -1239,6 +1226,22 @@ class BackendApi:
1239
1226
  else:
1240
1227
  _query_params.append(('last_heartbeat', last_heartbeat))
1241
1228
 
1229
+ if sort_by is not None:
1230
+
1231
+ _query_params.append(('sort_by', sort_by))
1232
+
1233
+ if latest is not None:
1234
+
1235
+ _query_params.append(('latest', latest))
1236
+
1237
+ if page is not None:
1238
+
1239
+ _query_params.append(('page', page))
1240
+
1241
+ if size is not None:
1242
+
1243
+ _query_params.append(('size', size))
1244
+
1242
1245
  # process the header parameters
1243
1246
  # process the form parameters
1244
1247
  # 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 pydantic import StrictBool, StrictInt, StrictStr
27
29
 
28
- from typing import List, Optional
30
+ from typing import Optional
29
31
 
30
32
  from compute_api_client.models.backend_status import BackendStatus
31
33
  from compute_api_client.models.backend_type import BackendType
34
+ from compute_api_client.models.page_backend_type import PageBackendType
32
35
 
33
36
  from compute_api_client.api_client import ApiClient
34
37
  from compute_api_client.api_response import ApiResponse
@@ -319,10 +322,6 @@ class BackendTypesApi:
319
322
  @validate_call
320
323
  async def read_backend_types_backend_types_get(
321
324
  self,
322
- latest: Optional[StrictBool] = None,
323
- sort_by: Optional[StrictStr] = None,
324
- page_number: Optional[StrictInt] = None,
325
- items_per_page: Optional[StrictInt] = None,
326
325
  id: Optional[StrictInt] = None,
327
326
  name: Optional[StrictStr] = None,
328
327
  infrastructure: Optional[StrictStr] = None,
@@ -332,6 +331,10 @@ class BackendTypesApi:
332
331
  status: Optional[BackendStatus] = None,
333
332
  default_number_of_shots: Optional[StrictInt] = None,
334
333
  max_number_of_shots: Optional[StrictInt] = None,
334
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
335
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
336
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
337
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
335
338
  _request_timeout: Union[
336
339
  None,
337
340
  Annotated[StrictFloat, Field(gt=0)],
@@ -344,19 +347,11 @@ class BackendTypesApi:
344
347
  _content_type: Optional[StrictStr] = None,
345
348
  _headers: Optional[Dict[StrictStr, Any]] = None,
346
349
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
347
- ) -> List[BackendType]:
350
+ ) -> PageBackendType:
348
351
  """List backend types
349
352
 
350
353
  Read backend types.
351
354
 
352
- :param latest:
353
- :type latest: bool
354
- :param sort_by:
355
- :type sort_by: str
356
- :param page_number:
357
- :type page_number: int
358
- :param items_per_page:
359
- :type items_per_page: int
360
355
  :param id:
361
356
  :type id: int
362
357
  :param name:
@@ -375,6 +370,14 @@ class BackendTypesApi:
375
370
  :type default_number_of_shots: int
376
371
  :param max_number_of_shots:
377
372
  :type max_number_of_shots: int
373
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
374
+ :type sort_by: str
375
+ :param latest: If True gets the most recently created object.
376
+ :type latest: bool
377
+ :param page: Page number
378
+ :type page: int
379
+ :param size: Page size
380
+ :type size: int
378
381
  :param _request_timeout: timeout setting for this request. If one
379
382
  number provided, it will be total request
380
383
  timeout. It can also be a pair (tuple) of
@@ -398,10 +401,6 @@ class BackendTypesApi:
398
401
  """ # noqa: E501
399
402
 
400
403
  _param = self._read_backend_types_backend_types_get_serialize(
401
- latest=latest,
402
- sort_by=sort_by,
403
- page_number=page_number,
404
- items_per_page=items_per_page,
405
404
  id=id,
406
405
  name=name,
407
406
  infrastructure=infrastructure,
@@ -411,6 +410,10 @@ class BackendTypesApi:
411
410
  status=status,
412
411
  default_number_of_shots=default_number_of_shots,
413
412
  max_number_of_shots=max_number_of_shots,
413
+ sort_by=sort_by,
414
+ latest=latest,
415
+ page=page,
416
+ size=size,
414
417
  _request_auth=_request_auth,
415
418
  _content_type=_content_type,
416
419
  _headers=_headers,
@@ -418,7 +421,7 @@ class BackendTypesApi:
418
421
  )
419
422
 
420
423
  _response_types_map: Dict[str, Optional[str]] = {
421
- '200': "List[BackendType]",
424
+ '200': "PageBackendType",
422
425
  '422': "HTTPValidationError"
423
426
 
424
427
  }
@@ -436,10 +439,6 @@ class BackendTypesApi:
436
439
  @validate_call
437
440
  async def read_backend_types_backend_types_get_with_http_info(
438
441
  self,
439
- latest: Optional[StrictBool] = None,
440
- sort_by: Optional[StrictStr] = None,
441
- page_number: Optional[StrictInt] = None,
442
- items_per_page: Optional[StrictInt] = None,
443
442
  id: Optional[StrictInt] = None,
444
443
  name: Optional[StrictStr] = None,
445
444
  infrastructure: Optional[StrictStr] = None,
@@ -449,6 +448,10 @@ class BackendTypesApi:
449
448
  status: Optional[BackendStatus] = None,
450
449
  default_number_of_shots: Optional[StrictInt] = None,
451
450
  max_number_of_shots: Optional[StrictInt] = None,
451
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
452
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
453
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
454
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
452
455
  _request_timeout: Union[
453
456
  None,
454
457
  Annotated[StrictFloat, Field(gt=0)],
@@ -461,19 +464,11 @@ class BackendTypesApi:
461
464
  _content_type: Optional[StrictStr] = None,
462
465
  _headers: Optional[Dict[StrictStr, Any]] = None,
463
466
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
464
- ) -> ApiResponse[List[BackendType]]:
467
+ ) -> ApiResponse[PageBackendType]:
465
468
  """List backend types
466
469
 
467
470
  Read backend types.
468
471
 
469
- :param latest:
470
- :type latest: bool
471
- :param sort_by:
472
- :type sort_by: str
473
- :param page_number:
474
- :type page_number: int
475
- :param items_per_page:
476
- :type items_per_page: int
477
472
  :param id:
478
473
  :type id: int
479
474
  :param name:
@@ -492,6 +487,14 @@ class BackendTypesApi:
492
487
  :type default_number_of_shots: int
493
488
  :param max_number_of_shots:
494
489
  :type max_number_of_shots: int
490
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
491
+ :type sort_by: str
492
+ :param latest: If True gets the most recently created object.
493
+ :type latest: bool
494
+ :param page: Page number
495
+ :type page: int
496
+ :param size: Page size
497
+ :type size: int
495
498
  :param _request_timeout: timeout setting for this request. If one
496
499
  number provided, it will be total request
497
500
  timeout. It can also be a pair (tuple) of
@@ -515,10 +518,6 @@ class BackendTypesApi:
515
518
  """ # noqa: E501
516
519
 
517
520
  _param = self._read_backend_types_backend_types_get_serialize(
518
- latest=latest,
519
- sort_by=sort_by,
520
- page_number=page_number,
521
- items_per_page=items_per_page,
522
521
  id=id,
523
522
  name=name,
524
523
  infrastructure=infrastructure,
@@ -528,6 +527,10 @@ class BackendTypesApi:
528
527
  status=status,
529
528
  default_number_of_shots=default_number_of_shots,
530
529
  max_number_of_shots=max_number_of_shots,
530
+ sort_by=sort_by,
531
+ latest=latest,
532
+ page=page,
533
+ size=size,
531
534
  _request_auth=_request_auth,
532
535
  _content_type=_content_type,
533
536
  _headers=_headers,
@@ -535,7 +538,7 @@ class BackendTypesApi:
535
538
  )
536
539
 
537
540
  _response_types_map: Dict[str, Optional[str]] = {
538
- '200': "List[BackendType]",
541
+ '200': "PageBackendType",
539
542
  '422': "HTTPValidationError"
540
543
 
541
544
  }
@@ -553,10 +556,6 @@ class BackendTypesApi:
553
556
  @validate_call
554
557
  async def read_backend_types_backend_types_get_without_preload_content(
555
558
  self,
556
- latest: Optional[StrictBool] = None,
557
- sort_by: Optional[StrictStr] = None,
558
- page_number: Optional[StrictInt] = None,
559
- items_per_page: Optional[StrictInt] = None,
560
559
  id: Optional[StrictInt] = None,
561
560
  name: Optional[StrictStr] = None,
562
561
  infrastructure: Optional[StrictStr] = None,
@@ -566,6 +565,10 @@ class BackendTypesApi:
566
565
  status: Optional[BackendStatus] = None,
567
566
  default_number_of_shots: Optional[StrictInt] = None,
568
567
  max_number_of_shots: Optional[StrictInt] = None,
568
+ sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
569
+ latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
570
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
571
+ size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
569
572
  _request_timeout: Union[
570
573
  None,
571
574
  Annotated[StrictFloat, Field(gt=0)],
@@ -583,14 +586,6 @@ class BackendTypesApi:
583
586
 
584
587
  Read backend types.
585
588
 
586
- :param latest:
587
- :type latest: bool
588
- :param sort_by:
589
- :type sort_by: str
590
- :param page_number:
591
- :type page_number: int
592
- :param items_per_page:
593
- :type items_per_page: int
594
589
  :param id:
595
590
  :type id: int
596
591
  :param name:
@@ -609,6 +604,14 @@ class BackendTypesApi:
609
604
  :type default_number_of_shots: int
610
605
  :param max_number_of_shots:
611
606
  :type max_number_of_shots: int
607
+ :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
608
+ :type sort_by: str
609
+ :param latest: If True gets the most recently created object.
610
+ :type latest: bool
611
+ :param page: Page number
612
+ :type page: int
613
+ :param size: Page size
614
+ :type size: int
612
615
  :param _request_timeout: timeout setting for this request. If one
613
616
  number provided, it will be total request
614
617
  timeout. It can also be a pair (tuple) of
@@ -632,10 +635,6 @@ class BackendTypesApi:
632
635
  """ # noqa: E501
633
636
 
634
637
  _param = self._read_backend_types_backend_types_get_serialize(
635
- latest=latest,
636
- sort_by=sort_by,
637
- page_number=page_number,
638
- items_per_page=items_per_page,
639
638
  id=id,
640
639
  name=name,
641
640
  infrastructure=infrastructure,
@@ -645,6 +644,10 @@ class BackendTypesApi:
645
644
  status=status,
646
645
  default_number_of_shots=default_number_of_shots,
647
646
  max_number_of_shots=max_number_of_shots,
647
+ sort_by=sort_by,
648
+ latest=latest,
649
+ page=page,
650
+ size=size,
648
651
  _request_auth=_request_auth,
649
652
  _content_type=_content_type,
650
653
  _headers=_headers,
@@ -652,7 +655,7 @@ class BackendTypesApi:
652
655
  )
653
656
 
654
657
  _response_types_map: Dict[str, Optional[str]] = {
655
- '200': "List[BackendType]",
658
+ '200': "PageBackendType",
656
659
  '422': "HTTPValidationError"
657
660
 
658
661
  }
@@ -665,10 +668,6 @@ class BackendTypesApi:
665
668
 
666
669
  def _read_backend_types_backend_types_get_serialize(
667
670
  self,
668
- latest,
669
- sort_by,
670
- page_number,
671
- items_per_page,
672
671
  id,
673
672
  name,
674
673
  infrastructure,
@@ -678,6 +677,10 @@ class BackendTypesApi:
678
677
  status,
679
678
  default_number_of_shots,
680
679
  max_number_of_shots,
680
+ sort_by,
681
+ latest,
682
+ page,
683
+ size,
681
684
  _request_auth,
682
685
  _content_type,
683
686
  _headers,
@@ -699,22 +702,6 @@ class BackendTypesApi:
699
702
 
700
703
  # process the path parameters
701
704
  # process the query parameters
702
- if latest is not None:
703
-
704
- _query_params.append(('latest', latest))
705
-
706
- if sort_by is not None:
707
-
708
- _query_params.append(('sort_by', sort_by))
709
-
710
- if page_number is not None:
711
-
712
- _query_params.append(('page_number', page_number))
713
-
714
- if items_per_page is not None:
715
-
716
- _query_params.append(('items_per_page', items_per_page))
717
-
718
705
  if id is not None:
719
706
 
720
707
  _query_params.append(('id', id))
@@ -751,6 +738,22 @@ class BackendTypesApi:
751
738
 
752
739
  _query_params.append(('max_number_of_shots', max_number_of_shots))
753
740
 
741
+ if sort_by is not None:
742
+
743
+ _query_params.append(('sort_by', sort_by))
744
+
745
+ if latest is not None:
746
+
747
+ _query_params.append(('latest', latest))
748
+
749
+ if page is not None:
750
+
751
+ _query_params.append(('page', page))
752
+
753
+ if size is not None:
754
+
755
+ _query_params.append(('size', size))
756
+
754
757
  # process the header parameters
755
758
  # process the form parameters
756
759
  # process the body parameter