From 2634954334d5644ac13e99d499172fe1981a8e9d Mon Sep 17 00:00:00 2001 From: qutech-machine Date: Tue, 23 Jul 2024 14:17:52 +0000 Subject: [PATCH] Revert "Revert "[QI2-957] Implemented pagination using fastapi-pagination"" --- .openapi-generator/FILES | 36 +++ README.md | 20 +- compute_api_client/__init__.py | 20 +- compute_api_client/api/algorithms_api.py | 151 ++++----- compute_api_client/api/backend_api.py | 153 +++++----- compute_api_client/api/backend_types_api.py | 153 +++++----- compute_api_client/api/batch_jobs_api.py | 151 ++++----- compute_api_client/api/commits_api.py | 153 +++++----- compute_api_client/api/files_api.py | 153 +++++----- compute_api_client/api/final_results_api.py | 2 +- compute_api_client/api/jobs_api.py | 153 +++++----- compute_api_client/api/languages_api.py | 149 ++++----- compute_api_client/api/members_api.py | 153 +++++----- compute_api_client/api/metadata_api.py | 87 +++++- compute_api_client/api/permissions_api.py | 288 +++++++++--------- compute_api_client/api/projects_api.py | 151 ++++----- compute_api_client/api/reservations_api.py | 153 +++++----- compute_api_client/api/results_api.py | 231 +++++++++----- compute_api_client/api/teams_api.py | 153 +++++----- compute_api_client/api/transactions_api.py | 153 +++++----- compute_api_client/api/users_api.py | 153 +++++----- compute_api_client/api_client.py | 2 +- compute_api_client/configuration.py | 2 +- compute_api_client/docs/AlgorithmsApi.md | 24 +- compute_api_client/docs/BackendApi.md | 24 +- compute_api_client/docs/BackendTypesApi.md | 24 +- compute_api_client/docs/BatchJobsApi.md | 24 +- compute_api_client/docs/CommitsApi.md | 24 +- compute_api_client/docs/FilesApi.md | 24 +- compute_api_client/docs/JobsApi.md | 24 +- compute_api_client/docs/LanguagesApi.md | 24 +- compute_api_client/docs/MembersApi.md | 24 +- compute_api_client/docs/MetadataApi.md | 16 +- compute_api_client/docs/PageAlgorithm.md | 32 ++ compute_api_client/docs/PageBackend.md | 32 ++ compute_api_client/docs/PageBackendType.md | 32 ++ compute_api_client/docs/PageBatchJob.md | 32 ++ compute_api_client/docs/PageCommit.md | 32 ++ compute_api_client/docs/PageFile.md | 32 ++ compute_api_client/docs/PageJob.md | 32 ++ compute_api_client/docs/PageLanguage.md | 32 ++ compute_api_client/docs/PageMember.md | 32 ++ compute_api_client/docs/PageMetadata.md | 32 ++ compute_api_client/docs/PagePermission.md | 32 ++ .../docs/PagePermissionGroup.md | 32 ++ compute_api_client/docs/PageProject.md | 32 ++ compute_api_client/docs/PageReservation.md | 32 ++ compute_api_client/docs/PageResult.md | 32 ++ compute_api_client/docs/PageTeam.md | 32 ++ compute_api_client/docs/PageTransaction.md | 32 ++ compute_api_client/docs/PageUser.md | 32 ++ compute_api_client/docs/PermissionsApi.md | 48 +-- compute_api_client/docs/ProjectsApi.md | 24 +- compute_api_client/docs/ReservationsApi.md | 24 +- compute_api_client/docs/ResultsApi.md | 40 ++- compute_api_client/docs/TeamsApi.md | 24 +- compute_api_client/docs/TransactionsApi.md | 24 +- compute_api_client/docs/UsersApi.md | 24 +- compute_api_client/exceptions.py | 2 +- compute_api_client/models/__init__.py | 20 +- compute_api_client/models/algorithm.py | 2 +- compute_api_client/models/algorithm_in.py | 2 +- compute_api_client/models/algorithm_type.py | 2 +- compute_api_client/models/backend.py | 2 +- compute_api_client/models/backend_in.py | 2 +- compute_api_client/models/backend_patch.py | 2 +- compute_api_client/models/backend_status.py | 2 +- compute_api_client/models/backend_type.py | 2 +- .../models/backend_with_authentication.py | 2 +- compute_api_client/models/batch_job.py | 2 +- compute_api_client/models/batch_job_in.py | 2 +- compute_api_client/models/batch_job_status.py | 2 +- compute_api_client/models/commit.py | 2 +- compute_api_client/models/commit_in.py | 2 +- compute_api_client/models/compile_stage.py | 2 +- compute_api_client/models/domain.py | 2 +- compute_api_client/models/file.py | 2 +- compute_api_client/models/file_in.py | 2 +- compute_api_client/models/final_result.py | 2 +- compute_api_client/models/final_result_in.py | 2 +- .../models/http_not_found_error.py | 2 +- .../models/http_validation_error.py | 2 +- compute_api_client/models/job.py | 2 +- compute_api_client/models/job_in.py | 2 +- compute_api_client/models/job_patch.py | 2 +- compute_api_client/models/job_status.py | 2 +- compute_api_client/models/language.py | 2 +- compute_api_client/models/location_inner.py | 2 +- compute_api_client/models/member.py | 2 +- compute_api_client/models/member_in.py | 2 +- compute_api_client/models/metadata.py | 2 +- compute_api_client/models/metadata_in.py | 2 +- compute_api_client/models/page_algorithm.py | 125 ++++++++ compute_api_client/models/page_backend.py | 125 ++++++++ .../models/page_backend_type.py | 125 ++++++++ compute_api_client/models/page_batch_job.py | 125 ++++++++ compute_api_client/models/page_commit.py | 125 ++++++++ compute_api_client/models/page_file.py | 125 ++++++++ compute_api_client/models/page_job.py | 125 ++++++++ compute_api_client/models/page_language.py | 125 ++++++++ compute_api_client/models/page_member.py | 125 ++++++++ compute_api_client/models/page_metadata.py | 125 ++++++++ compute_api_client/models/page_permission.py | 125 ++++++++ .../models/page_permission_group.py | 125 ++++++++ compute_api_client/models/page_project.py | 125 ++++++++ compute_api_client/models/page_reservation.py | 125 ++++++++ compute_api_client/models/page_result.py | 125 ++++++++ compute_api_client/models/page_team.py | 125 ++++++++ compute_api_client/models/page_transaction.py | 125 ++++++++ compute_api_client/models/page_user.py | 125 ++++++++ compute_api_client/models/permission.py | 2 +- compute_api_client/models/permission_group.py | 2 +- compute_api_client/models/project.py | 2 +- compute_api_client/models/project_in.py | 2 +- compute_api_client/models/project_patch.py | 2 +- compute_api_client/models/reservation.py | 2 +- compute_api_client/models/reservation_in.py | 2 +- compute_api_client/models/result.py | 2 +- compute_api_client/models/result_in.py | 2 +- compute_api_client/models/role.py | 2 +- compute_api_client/models/share_type.py | 2 +- compute_api_client/models/team.py | 2 +- compute_api_client/models/transaction.py | 2 +- compute_api_client/models/user.py | 2 +- compute_api_client/models/user_in.py | 2 +- compute_api_client/models/validation_error.py | 2 +- compute_api_client/rest.py | 2 +- .../test/test_page_algorithm.py | 76 +++++ compute_api_client/test/test_page_backend.py | 76 +++++ .../test/test_page_backend_type.py | 92 ++++++ .../test/test_page_batch_job.py | 90 ++++++ compute_api_client/test/test_page_commit.py | 74 +++++ compute_api_client/test/test_page_file.py | 78 +++++ compute_api_client/test/test_page_job.py | 82 +++++ compute_api_client/test/test_page_language.py | 70 +++++ compute_api_client/test/test_page_member.py | 74 +++++ compute_api_client/test/test_page_metadata.py | 72 +++++ .../test/test_page_permission.py | 70 +++++ .../test/test_page_permission_group.py | 68 +++++ compute_api_client/test/test_page_project.py | 76 +++++ .../test/test_page_reservation.py | 78 +++++ compute_api_client/test/test_page_result.py | 82 +++++ compute_api_client/test/test_page_team.py | 72 +++++ .../test/test_page_transaction.py | 78 +++++ compute_api_client/test/test_page_user.py | 80 +++++ pyproject.toml | 2 +- 146 files changed, 6050 insertions(+), 1546 deletions(-) create mode 100644 compute_api_client/docs/PageAlgorithm.md create mode 100644 compute_api_client/docs/PageBackend.md create mode 100644 compute_api_client/docs/PageBackendType.md create mode 100644 compute_api_client/docs/PageBatchJob.md create mode 100644 compute_api_client/docs/PageCommit.md create mode 100644 compute_api_client/docs/PageFile.md create mode 100644 compute_api_client/docs/PageJob.md create mode 100644 compute_api_client/docs/PageLanguage.md create mode 100644 compute_api_client/docs/PageMember.md create mode 100644 compute_api_client/docs/PageMetadata.md create mode 100644 compute_api_client/docs/PagePermission.md create mode 100644 compute_api_client/docs/PagePermissionGroup.md create mode 100644 compute_api_client/docs/PageProject.md create mode 100644 compute_api_client/docs/PageReservation.md create mode 100644 compute_api_client/docs/PageResult.md create mode 100644 compute_api_client/docs/PageTeam.md create mode 100644 compute_api_client/docs/PageTransaction.md create mode 100644 compute_api_client/docs/PageUser.md create mode 100644 compute_api_client/models/page_algorithm.py create mode 100644 compute_api_client/models/page_backend.py create mode 100644 compute_api_client/models/page_backend_type.py create mode 100644 compute_api_client/models/page_batch_job.py create mode 100644 compute_api_client/models/page_commit.py create mode 100644 compute_api_client/models/page_file.py create mode 100644 compute_api_client/models/page_job.py create mode 100644 compute_api_client/models/page_language.py create mode 100644 compute_api_client/models/page_member.py create mode 100644 compute_api_client/models/page_metadata.py create mode 100644 compute_api_client/models/page_permission.py create mode 100644 compute_api_client/models/page_permission_group.py create mode 100644 compute_api_client/models/page_project.py create mode 100644 compute_api_client/models/page_reservation.py create mode 100644 compute_api_client/models/page_result.py create mode 100644 compute_api_client/models/page_team.py create mode 100644 compute_api_client/models/page_transaction.py create mode 100644 compute_api_client/models/page_user.py create mode 100644 compute_api_client/test/test_page_algorithm.py create mode 100644 compute_api_client/test/test_page_backend.py create mode 100644 compute_api_client/test/test_page_backend_type.py create mode 100644 compute_api_client/test/test_page_batch_job.py create mode 100644 compute_api_client/test/test_page_commit.py create mode 100644 compute_api_client/test/test_page_file.py create mode 100644 compute_api_client/test/test_page_job.py create mode 100644 compute_api_client/test/test_page_language.py create mode 100644 compute_api_client/test/test_page_member.py create mode 100644 compute_api_client/test/test_page_metadata.py create mode 100644 compute_api_client/test/test_page_permission.py create mode 100644 compute_api_client/test/test_page_permission_group.py create mode 100644 compute_api_client/test/test_page_project.py create mode 100644 compute_api_client/test/test_page_reservation.py create mode 100644 compute_api_client/test/test_page_result.py create mode 100644 compute_api_client/test/test_page_team.py create mode 100644 compute_api_client/test/test_page_transaction.py create mode 100644 compute_api_client/test/test_page_user.py diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 0d76cee..40e3e52 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -64,6 +64,24 @@ compute_api_client/docs/MembersApi.md compute_api_client/docs/Metadata.md compute_api_client/docs/MetadataApi.md compute_api_client/docs/MetadataIn.md +compute_api_client/docs/PageAlgorithm.md +compute_api_client/docs/PageBackend.md +compute_api_client/docs/PageBackendType.md +compute_api_client/docs/PageBatchJob.md +compute_api_client/docs/PageCommit.md +compute_api_client/docs/PageFile.md +compute_api_client/docs/PageJob.md +compute_api_client/docs/PageLanguage.md +compute_api_client/docs/PageMember.md +compute_api_client/docs/PageMetadata.md +compute_api_client/docs/PagePermission.md +compute_api_client/docs/PagePermissionGroup.md +compute_api_client/docs/PageProject.md +compute_api_client/docs/PageReservation.md +compute_api_client/docs/PageResult.md +compute_api_client/docs/PageTeam.md +compute_api_client/docs/PageTransaction.md +compute_api_client/docs/PageUser.md compute_api_client/docs/Permission.md compute_api_client/docs/PermissionGroup.md compute_api_client/docs/PermissionsApi.md @@ -121,6 +139,24 @@ compute_api_client/models/member.py compute_api_client/models/member_in.py compute_api_client/models/metadata.py compute_api_client/models/metadata_in.py +compute_api_client/models/page_algorithm.py +compute_api_client/models/page_backend.py +compute_api_client/models/page_backend_type.py +compute_api_client/models/page_batch_job.py +compute_api_client/models/page_commit.py +compute_api_client/models/page_file.py +compute_api_client/models/page_job.py +compute_api_client/models/page_language.py +compute_api_client/models/page_member.py +compute_api_client/models/page_metadata.py +compute_api_client/models/page_permission.py +compute_api_client/models/page_permission_group.py +compute_api_client/models/page_project.py +compute_api_client/models/page_reservation.py +compute_api_client/models/page_result.py +compute_api_client/models/page_team.py +compute_api_client/models/page_transaction.py +compute_api_client/models/page_user.py compute_api_client/models/permission.py compute_api_client/models/permission_group.py compute_api_client/models/project.py diff --git a/README.md b/README.md index 3a0bf1a..7622aea 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # compute-api-client - **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. +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The `compute_api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -177,6 +177,24 @@ Class | Method | HTTP request | Description - [MemberIn](compute_api_client/docs/MemberIn.md) - [Metadata](compute_api_client/docs/Metadata.md) - [MetadataIn](compute_api_client/docs/MetadataIn.md) + - [PageAlgorithm](compute_api_client/docs/PageAlgorithm.md) + - [PageBackend](compute_api_client/docs/PageBackend.md) + - [PageBackendType](compute_api_client/docs/PageBackendType.md) + - [PageBatchJob](compute_api_client/docs/PageBatchJob.md) + - [PageCommit](compute_api_client/docs/PageCommit.md) + - [PageFile](compute_api_client/docs/PageFile.md) + - [PageJob](compute_api_client/docs/PageJob.md) + - [PageLanguage](compute_api_client/docs/PageLanguage.md) + - [PageMember](compute_api_client/docs/PageMember.md) + - [PageMetadata](compute_api_client/docs/PageMetadata.md) + - [PagePermission](compute_api_client/docs/PagePermission.md) + - [PagePermissionGroup](compute_api_client/docs/PagePermissionGroup.md) + - [PageProject](compute_api_client/docs/PageProject.md) + - [PageReservation](compute_api_client/docs/PageReservation.md) + - [PageResult](compute_api_client/docs/PageResult.md) + - [PageTeam](compute_api_client/docs/PageTeam.md) + - [PageTransaction](compute_api_client/docs/PageTransaction.md) + - [PageUser](compute_api_client/docs/PageUser.md) - [Permission](compute_api_client/docs/Permission.md) - [PermissionGroup](compute_api_client/docs/PermissionGroup.md) - [Project](compute_api_client/docs/Project.md) diff --git a/compute_api_client/__init__.py b/compute_api_client/__init__.py index 11dd809..70aae49 100644 --- a/compute_api_client/__init__.py +++ b/compute_api_client/__init__.py @@ -5,7 +5,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -80,6 +80,24 @@ from compute_api_client.models.member_in import MemberIn from compute_api_client.models.metadata import Metadata from compute_api_client.models.metadata_in import MetadataIn +from compute_api_client.models.page_algorithm import PageAlgorithm +from compute_api_client.models.page_backend import PageBackend +from compute_api_client.models.page_backend_type import PageBackendType +from compute_api_client.models.page_batch_job import PageBatchJob +from compute_api_client.models.page_commit import PageCommit +from compute_api_client.models.page_file import PageFile +from compute_api_client.models.page_job import PageJob +from compute_api_client.models.page_language import PageLanguage +from compute_api_client.models.page_member import PageMember +from compute_api_client.models.page_metadata import PageMetadata +from compute_api_client.models.page_permission import PagePermission +from compute_api_client.models.page_permission_group import PagePermissionGroup +from compute_api_client.models.page_project import PageProject +from compute_api_client.models.page_reservation import PageReservation +from compute_api_client.models.page_result import PageResult +from compute_api_client.models.page_team import PageTeam +from compute_api_client.models.page_transaction import PageTransaction +from compute_api_client.models.page_user import PageUser from compute_api_client.models.permission import Permission from compute_api_client.models.permission_group import PermissionGroup from compute_api_client.models.project import Project diff --git a/compute_api_client/api/algorithms_api.py b/compute_api_client/api/algorithms_api.py index c374bd1..d968d5b 100644 --- a/compute_api_client/api/algorithms_api.py +++ b/compute_api_client/api/algorithms_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -27,11 +27,12 @@ from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.algorithm import Algorithm from compute_api_client.models.algorithm_in import AlgorithmIn from compute_api_client.models.algorithm_type import AlgorithmType +from compute_api_client.models.page_algorithm import PageAlgorithm from compute_api_client.models.share_type import ShareType from compute_api_client.api_client import ApiClient @@ -862,10 +863,6 @@ def _read_algorithm_algorithms_id_get_serialize( async def read_algorithms_algorithms_get( self, search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, project_id: Optional[StrictInt] = None, type: Optional[AlgorithmType] = None, @@ -873,6 +870,10 @@ async def read_algorithms_algorithms_get( link__isnull: Optional[StrictBool] = None, link: Optional[StrictStr] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -885,21 +886,13 @@ async def read_algorithms_algorithms_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Algorithm]: + ) -> PageAlgorithm: """List algorithms List algorithms. :param search: Substring search for algorithm names :type search: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param project_id: @@ -914,6 +907,14 @@ async def read_algorithms_algorithms_get( :type link: str :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -938,10 +939,6 @@ async def read_algorithms_algorithms_get( _param = self._read_algorithms_algorithms_get_serialize( search=search, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, project_id=project_id, type=type, @@ -949,6 +946,10 @@ async def read_algorithms_algorithms_get( link__isnull=link__isnull, link=link, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -956,7 +957,7 @@ async def read_algorithms_algorithms_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Algorithm]", + '200': "PageAlgorithm", '422': "HTTPValidationError" } @@ -975,10 +976,6 @@ async def read_algorithms_algorithms_get( async def read_algorithms_algorithms_get_with_http_info( self, search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, project_id: Optional[StrictInt] = None, type: Optional[AlgorithmType] = None, @@ -986,6 +983,10 @@ async def read_algorithms_algorithms_get_with_http_info( link__isnull: Optional[StrictBool] = None, link: Optional[StrictStr] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -998,21 +999,13 @@ async def read_algorithms_algorithms_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Algorithm]]: + ) -> ApiResponse[PageAlgorithm]: """List algorithms List algorithms. :param search: Substring search for algorithm names :type search: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param project_id: @@ -1027,6 +1020,14 @@ async def read_algorithms_algorithms_get_with_http_info( :type link: str :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1051,10 +1052,6 @@ async def read_algorithms_algorithms_get_with_http_info( _param = self._read_algorithms_algorithms_get_serialize( search=search, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, project_id=project_id, type=type, @@ -1062,6 +1059,10 @@ async def read_algorithms_algorithms_get_with_http_info( link__isnull=link__isnull, link=link, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1069,7 +1070,7 @@ async def read_algorithms_algorithms_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Algorithm]", + '200': "PageAlgorithm", '422': "HTTPValidationError" } @@ -1088,10 +1089,6 @@ async def read_algorithms_algorithms_get_with_http_info( async def read_algorithms_algorithms_get_without_preload_content( self, search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, project_id: Optional[StrictInt] = None, type: Optional[AlgorithmType] = None, @@ -1099,6 +1096,10 @@ async def read_algorithms_algorithms_get_without_preload_content( link__isnull: Optional[StrictBool] = None, link: Optional[StrictStr] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1118,14 +1119,6 @@ async def read_algorithms_algorithms_get_without_preload_content( :param search: Substring search for algorithm names :type search: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param project_id: @@ -1140,6 +1133,14 @@ async def read_algorithms_algorithms_get_without_preload_content( :type link: str :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1164,10 +1165,6 @@ async def read_algorithms_algorithms_get_without_preload_content( _param = self._read_algorithms_algorithms_get_serialize( search=search, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, project_id=project_id, type=type, @@ -1175,6 +1172,10 @@ async def read_algorithms_algorithms_get_without_preload_content( link__isnull=link__isnull, link=link, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1182,7 +1183,7 @@ async def read_algorithms_algorithms_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Algorithm]", + '200': "PageAlgorithm", '422': "HTTPValidationError" } @@ -1196,10 +1197,6 @@ async def read_algorithms_algorithms_get_without_preload_content( def _read_algorithms_algorithms_get_serialize( self, search, - latest, - sort_by, - page_number, - items_per_page, id, project_id, type, @@ -1207,6 +1204,10 @@ def _read_algorithms_algorithms_get_serialize( link__isnull, link, name, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1232,22 +1233,6 @@ def _read_algorithms_algorithms_get_serialize( _query_params.append(('search', search)) - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1276,6 +1261,22 @@ def _read_algorithms_algorithms_get_serialize( _query_params.append(('name', name)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/backend_api.py b/compute_api_client/api/backend_api.py index 225f6db..ad11310 100644 --- a/compute_api_client/api/backend_api.py +++ b/compute_api_client/api/backend_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,17 +23,20 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.backend import Backend from compute_api_client.models.backend_in import BackendIn from compute_api_client.models.backend_patch import BackendPatch from compute_api_client.models.backend_status import BackendStatus from compute_api_client.models.backend_with_authentication import BackendWithAuthentication +from compute_api_client.models.page_backend import PageBackend from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -849,16 +852,16 @@ def _read_backend_self_backends_me_get_serialize( @validate_call async def read_backends_backends_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, location: Optional[StrictStr] = None, backend_type_id: Optional[StrictInt] = None, status: Optional[BackendStatus] = None, last_heartbeat: Optional[datetime] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -871,19 +874,11 @@ async def read_backends_backends_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Backend]: + ) -> PageBackend: """List backends Read backends. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -896,6 +891,14 @@ async def read_backends_backends_get( :type status: BackendStatus :param last_heartbeat: :type last_heartbeat: datetime + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -919,16 +922,16 @@ async def read_backends_backends_get( """ # noqa: E501 _param = self._read_backends_backends_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -936,7 +939,7 @@ async def read_backends_backends_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Backend]", + '200': "PageBackend", '422': "HTTPValidationError" } @@ -954,16 +957,16 @@ async def read_backends_backends_get( @validate_call async def read_backends_backends_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, location: Optional[StrictStr] = None, backend_type_id: Optional[StrictInt] = None, status: Optional[BackendStatus] = None, last_heartbeat: Optional[datetime] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -976,19 +979,11 @@ async def read_backends_backends_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Backend]]: + ) -> ApiResponse[PageBackend]: """List backends Read backends. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -1001,6 +996,14 @@ async def read_backends_backends_get_with_http_info( :type status: BackendStatus :param last_heartbeat: :type last_heartbeat: datetime + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1024,16 +1027,16 @@ async def read_backends_backends_get_with_http_info( """ # noqa: E501 _param = self._read_backends_backends_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1041,7 +1044,7 @@ async def read_backends_backends_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Backend]", + '200': "PageBackend", '422': "HTTPValidationError" } @@ -1059,16 +1062,16 @@ async def read_backends_backends_get_with_http_info( @validate_call async def read_backends_backends_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, location: Optional[StrictStr] = None, backend_type_id: Optional[StrictInt] = None, status: Optional[BackendStatus] = None, last_heartbeat: Optional[datetime] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1086,14 +1089,6 @@ async def read_backends_backends_get_without_preload_content( Read backends. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -1106,6 +1101,14 @@ async def read_backends_backends_get_without_preload_content( :type status: BackendStatus :param last_heartbeat: :type last_heartbeat: datetime + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1129,16 +1132,16 @@ async def read_backends_backends_get_without_preload_content( """ # noqa: E501 _param = self._read_backends_backends_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1146,7 +1149,7 @@ async def read_backends_backends_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Backend]", + '200': "PageBackend", '422': "HTTPValidationError" } @@ -1159,16 +1162,16 @@ async def read_backends_backends_get_without_preload_content( def _read_backends_backends_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, name, location, backend_type_id, status, last_heartbeat, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1190,22 +1193,6 @@ def _read_backends_backends_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1239,6 +1226,22 @@ def _read_backends_backends_get_serialize( else: _query_params.append(('last_heartbeat', last_heartbeat)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/backend_types_api.py b/compute_api_client/api/backend_types_api.py index 2f40365..7a0f89d 100644 --- a/compute_api_client/api/backend_types_api.py +++ b/compute_api_client/api/backend_types_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,12 +23,15 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.backend_status import BackendStatus from compute_api_client.models.backend_type import BackendType +from compute_api_client.models.page_backend_type import PageBackendType from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -319,10 +322,6 @@ def _read_backend_type_backend_types_id_get_serialize( @validate_call async def read_backend_types_backend_types_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, infrastructure: Optional[StrictStr] = None, @@ -332,6 +331,10 @@ async def read_backend_types_backend_types_get( status: Optional[BackendStatus] = None, default_number_of_shots: Optional[StrictInt] = None, max_number_of_shots: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -344,19 +347,11 @@ async def read_backend_types_backend_types_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[BackendType]: + ) -> PageBackendType: """List backend types Read backend types. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -375,6 +370,14 @@ async def read_backend_types_backend_types_get( :type default_number_of_shots: int :param max_number_of_shots: :type max_number_of_shots: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -398,10 +401,6 @@ async def read_backend_types_backend_types_get( """ # noqa: E501 _param = self._read_backend_types_backend_types_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, @@ -411,6 +410,10 @@ async def read_backend_types_backend_types_get( status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -418,7 +421,7 @@ async def read_backend_types_backend_types_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BackendType]", + '200': "PageBackendType", '422': "HTTPValidationError" } @@ -436,10 +439,6 @@ async def read_backend_types_backend_types_get( @validate_call async def read_backend_types_backend_types_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, infrastructure: Optional[StrictStr] = None, @@ -449,6 +448,10 @@ async def read_backend_types_backend_types_get_with_http_info( status: Optional[BackendStatus] = None, default_number_of_shots: Optional[StrictInt] = None, max_number_of_shots: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -461,19 +464,11 @@ async def read_backend_types_backend_types_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[BackendType]]: + ) -> ApiResponse[PageBackendType]: """List backend types Read backend types. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -492,6 +487,14 @@ async def read_backend_types_backend_types_get_with_http_info( :type default_number_of_shots: int :param max_number_of_shots: :type max_number_of_shots: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -515,10 +518,6 @@ async def read_backend_types_backend_types_get_with_http_info( """ # noqa: E501 _param = self._read_backend_types_backend_types_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, @@ -528,6 +527,10 @@ async def read_backend_types_backend_types_get_with_http_info( status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -535,7 +538,7 @@ async def read_backend_types_backend_types_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BackendType]", + '200': "PageBackendType", '422': "HTTPValidationError" } @@ -553,10 +556,6 @@ async def read_backend_types_backend_types_get_with_http_info( @validate_call async def read_backend_types_backend_types_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, infrastructure: Optional[StrictStr] = None, @@ -566,6 +565,10 @@ async def read_backend_types_backend_types_get_without_preload_content( status: Optional[BackendStatus] = None, default_number_of_shots: Optional[StrictInt] = None, max_number_of_shots: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -583,14 +586,6 @@ async def read_backend_types_backend_types_get_without_preload_content( Read backend types. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -609,6 +604,14 @@ async def read_backend_types_backend_types_get_without_preload_content( :type default_number_of_shots: int :param max_number_of_shots: :type max_number_of_shots: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -632,10 +635,6 @@ async def read_backend_types_backend_types_get_without_preload_content( """ # noqa: E501 _param = self._read_backend_types_backend_types_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, @@ -645,6 +644,10 @@ async def read_backend_types_backend_types_get_without_preload_content( status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -652,7 +655,7 @@ async def read_backend_types_backend_types_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BackendType]", + '200': "PageBackendType", '422': "HTTPValidationError" } @@ -665,10 +668,6 @@ async def read_backend_types_backend_types_get_without_preload_content( def _read_backend_types_backend_types_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, name, infrastructure, @@ -678,6 +677,10 @@ def _read_backend_types_backend_types_get_serialize( status, default_number_of_shots, max_number_of_shots, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -699,22 +702,6 @@ def _read_backend_types_backend_types_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -751,6 +738,22 @@ def _read_backend_types_backend_types_get_serialize( _query_params.append(('max_number_of_shots', max_number_of_shots)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/batch_jobs_api.py b/compute_api_client/api/batch_jobs_api.py index c11fd53..1c7e09c 100644 --- a/compute_api_client/api/batch_jobs_api.py +++ b/compute_api_client/api/batch_jobs_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,6 +23,8 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictInt, StrictStr @@ -33,6 +35,7 @@ from compute_api_client.models.batch_job import BatchJob from compute_api_client.models.batch_job_in import BatchJobIn from compute_api_client.models.batch_job_status import BatchJobStatus +from compute_api_client.models.page_batch_job import PageBatchJob from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -1399,10 +1402,6 @@ def _pop_batch_job_batch_jobs_pop_patch_serialize( @validate_call async def read_batch_jobs_batch_jobs_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, status: Optional[BatchJobStatus] = None, @@ -1416,6 +1415,10 @@ async def read_batch_jobs_batch_jobs_get( finished_at__isnull: Optional[StrictBool] = None, finished_at: Optional[datetime] = None, aggregated_algorithm_type: Optional[AlgorithmType] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1428,19 +1431,11 @@ async def read_batch_jobs_batch_jobs_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[BatchJob]: + ) -> PageBatchJob: """List batch jobs List batch jobs. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1467,6 +1462,14 @@ async def read_batch_jobs_batch_jobs_get( :type finished_at: datetime :param aggregated_algorithm_type: :type aggregated_algorithm_type: AlgorithmType + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1490,10 +1493,6 @@ async def read_batch_jobs_batch_jobs_get( """ # noqa: E501 _param = self._read_batch_jobs_batch_jobs_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, status=status, @@ -1507,6 +1506,10 @@ async def read_batch_jobs_batch_jobs_get( finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1514,7 +1517,7 @@ async def read_batch_jobs_batch_jobs_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BatchJob]", + '200': "PageBatchJob", '422': "HTTPValidationError" } @@ -1532,10 +1535,6 @@ async def read_batch_jobs_batch_jobs_get( @validate_call async def read_batch_jobs_batch_jobs_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, status: Optional[BatchJobStatus] = None, @@ -1549,6 +1548,10 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( finished_at__isnull: Optional[StrictBool] = None, finished_at: Optional[datetime] = None, aggregated_algorithm_type: Optional[AlgorithmType] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1561,19 +1564,11 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[BatchJob]]: + ) -> ApiResponse[PageBatchJob]: """List batch jobs List batch jobs. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1600,6 +1595,14 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( :type finished_at: datetime :param aggregated_algorithm_type: :type aggregated_algorithm_type: AlgorithmType + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1623,10 +1626,6 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( """ # noqa: E501 _param = self._read_batch_jobs_batch_jobs_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, status=status, @@ -1640,6 +1639,10 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1647,7 +1650,7 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BatchJob]", + '200': "PageBatchJob", '422': "HTTPValidationError" } @@ -1665,10 +1668,6 @@ async def read_batch_jobs_batch_jobs_get_with_http_info( @validate_call async def read_batch_jobs_batch_jobs_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, status: Optional[BatchJobStatus] = None, @@ -1682,6 +1681,10 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( finished_at__isnull: Optional[StrictBool] = None, finished_at: Optional[datetime] = None, aggregated_algorithm_type: Optional[AlgorithmType] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1699,14 +1702,6 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( List batch jobs. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1733,6 +1728,14 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( :type finished_at: datetime :param aggregated_algorithm_type: :type aggregated_algorithm_type: AlgorithmType + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1756,10 +1759,6 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( """ # noqa: E501 _param = self._read_batch_jobs_batch_jobs_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, status=status, @@ -1773,6 +1772,10 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1780,7 +1783,7 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BatchJob]", + '200': "PageBatchJob", '422': "HTTPValidationError" } @@ -1793,10 +1796,6 @@ async def read_batch_jobs_batch_jobs_get_without_preload_content( def _read_batch_jobs_batch_jobs_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, created_on, status, @@ -1810,6 +1809,10 @@ def _read_batch_jobs_batch_jobs_get_serialize( finished_at__isnull, finished_at, aggregated_algorithm_type, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1831,22 +1834,6 @@ def _read_batch_jobs_batch_jobs_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1935,6 +1922,22 @@ def _read_batch_jobs_batch_jobs_get_serialize( _query_params.append(('aggregated_algorithm_type', aggregated_algorithm_type.value)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/commits_api.py b/compute_api_client/api/commits_api.py index 330d507..fff5c1a 100644 --- a/compute_api_client/api/commits_api.py +++ b/compute_api_client/api/commits_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,14 +23,17 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.commit import Commit from compute_api_client.models.commit_in import CommitIn +from compute_api_client.models.page_commit import PageCommit from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -859,15 +862,15 @@ def _read_commit_commits_id_get_serialize( @validate_call async def read_commits_commits_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, hash: Optional[StrictStr] = None, description: Optional[StrictStr] = None, algorithm_id: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -880,19 +883,11 @@ async def read_commits_commits_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Commit]: + ) -> PageCommit: """List commits List commits. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -903,6 +898,14 @@ async def read_commits_commits_get( :type description: str :param algorithm_id: :type algorithm_id: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -926,15 +929,15 @@ async def read_commits_commits_get( """ # noqa: E501 _param = self._read_commits_commits_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -942,7 +945,7 @@ async def read_commits_commits_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Commit]", + '200': "PageCommit", '422': "HTTPValidationError" } @@ -960,15 +963,15 @@ async def read_commits_commits_get( @validate_call async def read_commits_commits_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, hash: Optional[StrictStr] = None, description: Optional[StrictStr] = None, algorithm_id: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -981,19 +984,11 @@ async def read_commits_commits_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Commit]]: + ) -> ApiResponse[PageCommit]: """List commits List commits. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1004,6 +999,14 @@ async def read_commits_commits_get_with_http_info( :type description: str :param algorithm_id: :type algorithm_id: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1027,15 +1030,15 @@ async def read_commits_commits_get_with_http_info( """ # noqa: E501 _param = self._read_commits_commits_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1043,7 +1046,7 @@ async def read_commits_commits_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Commit]", + '200': "PageCommit", '422': "HTTPValidationError" } @@ -1061,15 +1064,15 @@ async def read_commits_commits_get_with_http_info( @validate_call async def read_commits_commits_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, hash: Optional[StrictStr] = None, description: Optional[StrictStr] = None, algorithm_id: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1087,14 +1090,6 @@ async def read_commits_commits_get_without_preload_content( List commits. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1105,6 +1100,14 @@ async def read_commits_commits_get_without_preload_content( :type description: str :param algorithm_id: :type algorithm_id: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1128,15 +1131,15 @@ async def read_commits_commits_get_without_preload_content( """ # noqa: E501 _param = self._read_commits_commits_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1144,7 +1147,7 @@ async def read_commits_commits_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Commit]", + '200': "PageCommit", '422': "HTTPValidationError" } @@ -1157,15 +1160,15 @@ async def read_commits_commits_get_without_preload_content( def _read_commits_commits_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, created_on, hash, description, algorithm_id, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1187,22 +1190,6 @@ def _read_commits_commits_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1232,6 +1219,22 @@ def _read_commits_commits_get_serialize( _query_params.append(('algorithm_id', algorithm_id)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/files_api.py b/compute_api_client/api/files_api.py index 8731991..ef428bd 100644 --- a/compute_api_client/api/files_api.py +++ b/compute_api_client/api/files_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,13 +23,16 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.compile_stage import CompileStage from compute_api_client.models.file import File from compute_api_client.models.file_in import FileIn +from compute_api_client.models.page_file import PageFile from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -858,16 +861,16 @@ def _read_file_files_id_get_serialize( @validate_call async def read_files_files_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, commit_id: Optional[StrictInt] = None, content: Optional[StrictStr] = None, language_id: Optional[StrictInt] = None, compile_stage: Optional[CompileStage] = None, generated: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -880,19 +883,11 @@ async def read_files_files_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[File]: + ) -> PageFile: """List files List files. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param commit_id: @@ -905,6 +900,14 @@ async def read_files_files_get( :type compile_stage: CompileStage :param generated: :type generated: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -928,16 +931,16 @@ async def read_files_files_get( """ # noqa: E501 _param = self._read_files_files_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -945,7 +948,7 @@ async def read_files_files_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[File]", + '200': "PageFile", '422': "HTTPValidationError" } @@ -963,16 +966,16 @@ async def read_files_files_get( @validate_call async def read_files_files_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, commit_id: Optional[StrictInt] = None, content: Optional[StrictStr] = None, language_id: Optional[StrictInt] = None, compile_stage: Optional[CompileStage] = None, generated: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -985,19 +988,11 @@ async def read_files_files_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[File]]: + ) -> ApiResponse[PageFile]: """List files List files. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param commit_id: @@ -1010,6 +1005,14 @@ async def read_files_files_get_with_http_info( :type compile_stage: CompileStage :param generated: :type generated: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1033,16 +1036,16 @@ async def read_files_files_get_with_http_info( """ # noqa: E501 _param = self._read_files_files_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1050,7 +1053,7 @@ async def read_files_files_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[File]", + '200': "PageFile", '422': "HTTPValidationError" } @@ -1068,16 +1071,16 @@ async def read_files_files_get_with_http_info( @validate_call async def read_files_files_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, commit_id: Optional[StrictInt] = None, content: Optional[StrictStr] = None, language_id: Optional[StrictInt] = None, compile_stage: Optional[CompileStage] = None, generated: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1095,14 +1098,6 @@ async def read_files_files_get_without_preload_content( List files. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param commit_id: @@ -1115,6 +1110,14 @@ async def read_files_files_get_without_preload_content( :type compile_stage: CompileStage :param generated: :type generated: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1138,16 +1141,16 @@ async def read_files_files_get_without_preload_content( """ # noqa: E501 _param = self._read_files_files_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1155,7 +1158,7 @@ async def read_files_files_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[File]", + '200': "PageFile", '422': "HTTPValidationError" } @@ -1168,16 +1171,16 @@ async def read_files_files_get_without_preload_content( def _read_files_files_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, commit_id, content, language_id, compile_stage, generated, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1199,22 +1202,6 @@ def _read_files_files_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1239,6 +1226,22 @@ def _read_files_files_get_serialize( _query_params.append(('generated', generated)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/final_results_api.py b/compute_api_client/api/final_results_api.py index 496261f..96e65d0 100644 --- a/compute_api_client/api/final_results_api.py +++ b/compute_api_client/api/final_results_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/api/jobs_api.py b/compute_api_client/api/jobs_api.py index aa2b271..e5bc32c 100644 --- a/compute_api_client/api/jobs_api.py +++ b/compute_api_client/api/jobs_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,17 +23,20 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.algorithm_type import AlgorithmType from compute_api_client.models.job import Job from compute_api_client.models.job_in import JobIn from compute_api_client.models.job_patch import JobPatch from compute_api_client.models.job_status import JobStatus +from compute_api_client.models.page_job import PageJob from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -862,10 +865,6 @@ def _read_job_jobs_id_get_serialize( @validate_call async def read_jobs_jobs_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, file_id: Optional[StrictInt] = None, @@ -878,6 +877,10 @@ async def read_jobs_jobs_get( finished_at: Optional[datetime] = None, number_of_shots__isnull: Optional[StrictBool] = None, number_of_shots: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -890,19 +893,11 @@ async def read_jobs_jobs_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Job]: + ) -> PageJob: """List jobs List jobs. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -927,6 +922,14 @@ async def read_jobs_jobs_get( :type number_of_shots__isnull: bool :param number_of_shots: :type number_of_shots: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -950,10 +953,6 @@ async def read_jobs_jobs_get( """ # noqa: E501 _param = self._read_jobs_jobs_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, file_id=file_id, @@ -966,6 +965,10 @@ async def read_jobs_jobs_get( finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -973,7 +976,7 @@ async def read_jobs_jobs_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Job]", + '200': "PageJob", '422': "HTTPValidationError" } @@ -991,10 +994,6 @@ async def read_jobs_jobs_get( @validate_call async def read_jobs_jobs_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, file_id: Optional[StrictInt] = None, @@ -1007,6 +1006,10 @@ async def read_jobs_jobs_get_with_http_info( finished_at: Optional[datetime] = None, number_of_shots__isnull: Optional[StrictBool] = None, number_of_shots: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1019,19 +1022,11 @@ async def read_jobs_jobs_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Job]]: + ) -> ApiResponse[PageJob]: """List jobs List jobs. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1056,6 +1051,14 @@ async def read_jobs_jobs_get_with_http_info( :type number_of_shots__isnull: bool :param number_of_shots: :type number_of_shots: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1079,10 +1082,6 @@ async def read_jobs_jobs_get_with_http_info( """ # noqa: E501 _param = self._read_jobs_jobs_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, file_id=file_id, @@ -1095,6 +1094,10 @@ async def read_jobs_jobs_get_with_http_info( finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1102,7 +1105,7 @@ async def read_jobs_jobs_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Job]", + '200': "PageJob", '422': "HTTPValidationError" } @@ -1120,10 +1123,6 @@ async def read_jobs_jobs_get_with_http_info( @validate_call async def read_jobs_jobs_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, file_id: Optional[StrictInt] = None, @@ -1136,6 +1135,10 @@ async def read_jobs_jobs_get_without_preload_content( finished_at: Optional[datetime] = None, number_of_shots__isnull: Optional[StrictBool] = None, number_of_shots: Optional[StrictInt] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1153,14 +1156,6 @@ async def read_jobs_jobs_get_without_preload_content( List jobs. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1185,6 +1180,14 @@ async def read_jobs_jobs_get_without_preload_content( :type number_of_shots__isnull: bool :param number_of_shots: :type number_of_shots: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1208,10 +1211,6 @@ async def read_jobs_jobs_get_without_preload_content( """ # noqa: E501 _param = self._read_jobs_jobs_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, file_id=file_id, @@ -1224,6 +1223,10 @@ async def read_jobs_jobs_get_without_preload_content( finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1231,7 +1234,7 @@ async def read_jobs_jobs_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Job]", + '200': "PageJob", '422': "HTTPValidationError" } @@ -1244,10 +1247,6 @@ async def read_jobs_jobs_get_without_preload_content( def _read_jobs_jobs_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, created_on, file_id, @@ -1260,6 +1259,10 @@ def _read_jobs_jobs_get_serialize( finished_at, number_of_shots__isnull, number_of_shots, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1281,22 +1284,6 @@ def _read_jobs_jobs_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1372,6 +1359,22 @@ def _read_jobs_jobs_get_serialize( _query_params.append(('number_of_shots', number_of_shots)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/languages_api.py b/compute_api_client/api/languages_api.py index 3b4ed9f..98196e2 100644 --- a/compute_api_client/api/languages_api.py +++ b/compute_api_client/api/languages_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,11 +23,14 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.language import Language +from compute_api_client.models.page_language import PageLanguage from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -319,13 +322,13 @@ def _read_language_languages_id_get_serialize( async def read_languages_languages_get( self, q: Optional[StrictStr] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, version: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -338,27 +341,27 @@ async def read_languages_languages_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Language]: + ) -> PageLanguage: """List languages List languages. :param q: :type q: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: :type name: str :param version: :type version: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -383,13 +386,13 @@ async def read_languages_languages_get( _param = self._read_languages_languages_get_serialize( q=q, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, version=version, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -397,7 +400,7 @@ async def read_languages_languages_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Language]", + '200': "PageLanguage", '422': "HTTPValidationError" } @@ -416,13 +419,13 @@ async def read_languages_languages_get( async def read_languages_languages_get_with_http_info( self, q: Optional[StrictStr] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, version: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -435,27 +438,27 @@ async def read_languages_languages_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Language]]: + ) -> ApiResponse[PageLanguage]: """List languages List languages. :param q: :type q: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: :type name: str :param version: :type version: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -480,13 +483,13 @@ async def read_languages_languages_get_with_http_info( _param = self._read_languages_languages_get_serialize( q=q, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, version=version, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -494,7 +497,7 @@ async def read_languages_languages_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Language]", + '200': "PageLanguage", '422': "HTTPValidationError" } @@ -513,13 +516,13 @@ async def read_languages_languages_get_with_http_info( async def read_languages_languages_get_without_preload_content( self, q: Optional[StrictStr] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, version: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -539,20 +542,20 @@ async def read_languages_languages_get_without_preload_content( :param q: :type q: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: :type name: str :param version: :type version: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -577,13 +580,13 @@ async def read_languages_languages_get_without_preload_content( _param = self._read_languages_languages_get_serialize( q=q, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, version=version, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -591,7 +594,7 @@ async def read_languages_languages_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Language]", + '200': "PageLanguage", '422': "HTTPValidationError" } @@ -605,13 +608,13 @@ async def read_languages_languages_get_without_preload_content( def _read_languages_languages_get_serialize( self, q, - latest, - sort_by, - page_number, - items_per_page, id, name, version, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -637,33 +640,33 @@ def _read_languages_languages_get_serialize( _query_params.append(('q', q)) - if latest is not None: + if id is not None: - _query_params.append(('latest', latest)) + _query_params.append(('id', id)) - if sort_by is not None: + if name is not None: - _query_params.append(('sort_by', sort_by)) + _query_params.append(('name', name)) - if page_number is not None: + if version is not None: - _query_params.append(('page_number', page_number)) + _query_params.append(('version', version)) - if items_per_page is not None: + if sort_by is not None: - _query_params.append(('items_per_page', items_per_page)) + _query_params.append(('sort_by', sort_by)) - if id is not None: + if latest is not None: - _query_params.append(('id', id)) + _query_params.append(('latest', latest)) - if name is not None: + if page is not None: - _query_params.append(('name', name)) + _query_params.append(('page', page)) - if version is not None: + if size is not None: - _query_params.append(('version', version)) + _query_params.append(('size', size)) # process the header parameters # process the form parameters diff --git a/compute_api_client/api/members_api.py b/compute_api_client/api/members_api.py index 456a648..e3a5701 100644 --- a/compute_api_client/api/members_api.py +++ b/compute_api_client/api/members_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,12 +23,15 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.member import Member from compute_api_client.models.member_in import MemberIn +from compute_api_client.models.page_member import PageMember from compute_api_client.models.role import Role from compute_api_client.api_client import ApiClient @@ -857,14 +860,14 @@ def _read_member_members_id_get_serialize( @validate_call async def read_members_members_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, team_id: Optional[StrictInt] = None, role: Optional[Role] = None, is_active: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -877,19 +880,11 @@ async def read_members_members_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Member]: + ) -> PageMember: """List members Read members. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param team_id: @@ -898,6 +893,14 @@ async def read_members_members_get( :type role: Role :param is_active: :type is_active: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -921,14 +924,14 @@ async def read_members_members_get( """ # noqa: E501 _param = self._read_members_members_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, team_id=team_id, role=role, is_active=is_active, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -936,7 +939,7 @@ async def read_members_members_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Member]", + '200': "PageMember", '422': "HTTPValidationError" } @@ -954,14 +957,14 @@ async def read_members_members_get( @validate_call async def read_members_members_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, team_id: Optional[StrictInt] = None, role: Optional[Role] = None, is_active: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -974,19 +977,11 @@ async def read_members_members_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Member]]: + ) -> ApiResponse[PageMember]: """List members Read members. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param team_id: @@ -995,6 +990,14 @@ async def read_members_members_get_with_http_info( :type role: Role :param is_active: :type is_active: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1018,14 +1021,14 @@ async def read_members_members_get_with_http_info( """ # noqa: E501 _param = self._read_members_members_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, team_id=team_id, role=role, is_active=is_active, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1033,7 +1036,7 @@ async def read_members_members_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Member]", + '200': "PageMember", '422': "HTTPValidationError" } @@ -1051,14 +1054,14 @@ async def read_members_members_get_with_http_info( @validate_call async def read_members_members_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, team_id: Optional[StrictInt] = None, role: Optional[Role] = None, is_active: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1076,14 +1079,6 @@ async def read_members_members_get_without_preload_content( Read members. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param team_id: @@ -1092,6 +1087,14 @@ async def read_members_members_get_without_preload_content( :type role: Role :param is_active: :type is_active: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1115,14 +1118,14 @@ async def read_members_members_get_without_preload_content( """ # noqa: E501 _param = self._read_members_members_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, team_id=team_id, role=role, is_active=is_active, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1130,7 +1133,7 @@ async def read_members_members_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Member]", + '200': "PageMember", '422': "HTTPValidationError" } @@ -1143,14 +1146,14 @@ async def read_members_members_get_without_preload_content( def _read_members_members_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, team_id, role, is_active, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1172,22 +1175,6 @@ def _read_members_members_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1204,6 +1191,22 @@ def _read_members_members_get_serialize( _query_params.append(('is_active', is_active)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/metadata_api.py b/compute_api_client/api/metadata_api.py index 105e7ab..526f149 100644 --- a/compute_api_client/api/metadata_api.py +++ b/compute_api_client/api/metadata_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,12 +23,15 @@ except ImportError: from typing_extensions import Annotated -from pydantic import StrictInt +from pydantic import Field +from typing_extensions import Annotated +from pydantic import StrictBool, StrictInt, StrictStr -from typing import List +from typing import Optional from compute_api_client.models.metadata import Metadata from compute_api_client.models.metadata_in import MetadataIn +from compute_api_client.models.page_metadata import PageMetadata from compute_api_client.api_client import ApiClient from compute_api_client.api_response import ApiResponse @@ -330,6 +333,10 @@ def _create_metadata_self_metadata_post_serialize( async def read_metadata_by_backend_id_metadata_backend_backend_id_get( self, backend_id: StrictInt, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -342,13 +349,21 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Metadata]: + ) -> PageMetadata: """Retrieve metadata by backend ID Get metadata by job ID. :param backend_id: (required) :type backend_id: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -373,6 +388,10 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get( _param = self._read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize( backend_id=backend_id, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -380,7 +399,7 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Metadata]", + '200': "PageMetadata", '422': "HTTPValidationError" } @@ -399,6 +418,10 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get( async def read_metadata_by_backend_id_metadata_backend_backend_id_get_with_http_info( self, backend_id: StrictInt, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -411,13 +434,21 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_with_http_ _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Metadata]]: + ) -> ApiResponse[PageMetadata]: """Retrieve metadata by backend ID Get metadata by job ID. :param backend_id: (required) :type backend_id: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -442,6 +473,10 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_with_http_ _param = self._read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize( backend_id=backend_id, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -449,7 +484,7 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_with_http_ ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Metadata]", + '200': "PageMetadata", '422': "HTTPValidationError" } @@ -468,6 +503,10 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_with_http_ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_without_preload_content( self, backend_id: StrictInt, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -487,6 +526,14 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_without_pr :param backend_id: (required) :type backend_id: int + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -511,6 +558,10 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_without_pr _param = self._read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize( backend_id=backend_id, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -518,7 +569,7 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_without_pr ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Metadata]", + '200': "PageMetadata", '422': "HTTPValidationError" } @@ -532,6 +583,10 @@ async def read_metadata_by_backend_id_metadata_backend_backend_id_get_without_pr def _read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize( self, backend_id, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -555,6 +610,22 @@ def _read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize( if backend_id is not None: _path_params['backend_id'] = backend_id # process the query parameters + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/permissions_api.py b/compute_api_client/api/permissions_api.py index 606b44b..243fd98 100644 --- a/compute_api_client/api/permissions_api.py +++ b/compute_api_client/api/permissions_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,10 +23,14 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional +from compute_api_client.models.page_permission import PagePermission +from compute_api_client.models.page_permission_group import PagePermissionGroup from compute_api_client.models.permission import Permission from compute_api_client.models.permission_group import PermissionGroup @@ -319,12 +323,12 @@ def _read_permission_group_permission_groups_id_get_serialize( @validate_call async def read_permission_groups_permission_groups_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -337,23 +341,23 @@ async def read_permission_groups_permission_groups_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[PermissionGroup]: + ) -> PagePermissionGroup: """List permission groups Read permissions groups. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -377,12 +381,12 @@ async def read_permission_groups_permission_groups_get( """ # noqa: E501 _param = self._read_permission_groups_permission_groups_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -390,7 +394,7 @@ async def read_permission_groups_permission_groups_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PermissionGroup]", + '200': "PagePermissionGroup", '422': "HTTPValidationError" } @@ -408,12 +412,12 @@ async def read_permission_groups_permission_groups_get( @validate_call async def read_permission_groups_permission_groups_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -426,23 +430,23 @@ async def read_permission_groups_permission_groups_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[PermissionGroup]]: + ) -> ApiResponse[PagePermissionGroup]: """List permission groups Read permissions groups. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -466,12 +470,12 @@ async def read_permission_groups_permission_groups_get_with_http_info( """ # noqa: E501 _param = self._read_permission_groups_permission_groups_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -479,7 +483,7 @@ async def read_permission_groups_permission_groups_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PermissionGroup]", + '200': "PagePermissionGroup", '422': "HTTPValidationError" } @@ -497,12 +501,12 @@ async def read_permission_groups_permission_groups_get_with_http_info( @validate_call async def read_permission_groups_permission_groups_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -520,18 +524,18 @@ async def read_permission_groups_permission_groups_get_without_preload_content( Read permissions groups. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -555,12 +559,12 @@ async def read_permission_groups_permission_groups_get_without_preload_content( """ # noqa: E501 _param = self._read_permission_groups_permission_groups_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -568,7 +572,7 @@ async def read_permission_groups_permission_groups_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[PermissionGroup]", + '200': "PagePermissionGroup", '422': "HTTPValidationError" } @@ -581,12 +585,12 @@ async def read_permission_groups_permission_groups_get_without_preload_content( def _read_permission_groups_permission_groups_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, name, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -608,29 +612,29 @@ def _read_permission_groups_permission_groups_get_serialize( # process the path parameters # process the query parameters - if latest is not None: + if id is not None: - _query_params.append(('latest', latest)) + _query_params.append(('id', id)) - if sort_by is not None: + if name is not None: - _query_params.append(('sort_by', sort_by)) + _query_params.append(('name', name)) - if page_number is not None: + if sort_by is not None: - _query_params.append(('page_number', page_number)) + _query_params.append(('sort_by', sort_by)) - if items_per_page is not None: + if latest is not None: - _query_params.append(('items_per_page', items_per_page)) + _query_params.append(('latest', latest)) - if id is not None: + if page is not None: - _query_params.append(('id', id)) + _query_params.append(('page', page)) - if name is not None: + if size is not None: - _query_params.append(('name', name)) + _query_params.append(('size', size)) # process the header parameters # process the form parameters @@ -939,13 +943,13 @@ def _read_permission_permissions_id_get_serialize( @validate_call async def read_permissions_permissions_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, permission: Optional[StrictStr] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -958,25 +962,25 @@ async def read_permissions_permissions_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Permission]: + ) -> PagePermission: """List permissions Read permissions. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param permission: :type permission: str :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1000,13 +1004,13 @@ async def read_permissions_permissions_get( """ # noqa: E501 _param = self._read_permissions_permissions_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, permission=permission, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1014,7 +1018,7 @@ async def read_permissions_permissions_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Permission]", + '200': "PagePermission", '422': "HTTPValidationError" } @@ -1032,13 +1036,13 @@ async def read_permissions_permissions_get( @validate_call async def read_permissions_permissions_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, permission: Optional[StrictStr] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1051,25 +1055,25 @@ async def read_permissions_permissions_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Permission]]: + ) -> ApiResponse[PagePermission]: """List permissions Read permissions. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param permission: :type permission: str :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1093,13 +1097,13 @@ async def read_permissions_permissions_get_with_http_info( """ # noqa: E501 _param = self._read_permissions_permissions_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, permission=permission, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1107,7 +1111,7 @@ async def read_permissions_permissions_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Permission]", + '200': "PagePermission", '422': "HTTPValidationError" } @@ -1125,13 +1129,13 @@ async def read_permissions_permissions_get_with_http_info( @validate_call async def read_permissions_permissions_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, permission: Optional[StrictStr] = None, name: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1149,20 +1153,20 @@ async def read_permissions_permissions_get_without_preload_content( Read permissions. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param permission: :type permission: str :param name: :type name: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1186,13 +1190,13 @@ async def read_permissions_permissions_get_without_preload_content( """ # noqa: E501 _param = self._read_permissions_permissions_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, permission=permission, name=name, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1200,7 +1204,7 @@ async def read_permissions_permissions_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Permission]", + '200': "PagePermission", '422': "HTTPValidationError" } @@ -1213,13 +1217,13 @@ async def read_permissions_permissions_get_without_preload_content( def _read_permissions_permissions_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, permission, name, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1241,33 +1245,33 @@ def _read_permissions_permissions_get_serialize( # process the path parameters # process the query parameters - if latest is not None: + if id is not None: - _query_params.append(('latest', latest)) + _query_params.append(('id', id)) - if sort_by is not None: + if permission is not None: - _query_params.append(('sort_by', sort_by)) + _query_params.append(('permission', permission)) - if page_number is not None: + if name is not None: - _query_params.append(('page_number', page_number)) + _query_params.append(('name', name)) - if items_per_page is not None: + if sort_by is not None: - _query_params.append(('items_per_page', items_per_page)) + _query_params.append(('sort_by', sort_by)) - if id is not None: + if latest is not None: - _query_params.append(('id', id)) + _query_params.append(('latest', latest)) - if permission is not None: + if page is not None: - _query_params.append(('permission', permission)) + _query_params.append(('page', page)) - if name is not None: + if size is not None: - _query_params.append(('name', name)) + _query_params.append(('size', size)) # process the header parameters # process the form parameters diff --git a/compute_api_client/api/projects_api.py b/compute_api_client/api/projects_api.py index ff42ae2..fce1e96 100644 --- a/compute_api_client/api/projects_api.py +++ b/compute_api_client/api/projects_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,8 +29,9 @@ from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional +from compute_api_client.models.page_project import PageProject from compute_api_client.models.project import Project from compute_api_client.models.project_in import ProjectIn from compute_api_client.models.project_patch import ProjectPatch @@ -1158,16 +1159,16 @@ def _read_project_projects_id_get_serialize( async def read_projects_projects_get( self, search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, owner_id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, starred: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1180,21 +1181,13 @@ async def read_projects_projects_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Project]: + ) -> PageProject: """List projects 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. :param search: Substring search for project names or description :type search: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1207,6 +1200,14 @@ async def read_projects_projects_get( :type description: str :param starred: :type starred: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1231,16 +1232,16 @@ async def read_projects_projects_get( _param = self._read_projects_projects_get_serialize( search=search, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1248,7 +1249,7 @@ async def read_projects_projects_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Project]", + '200': "PageProject", '422': "HTTPValidationError" } @@ -1267,16 +1268,16 @@ async def read_projects_projects_get( async def read_projects_projects_get_with_http_info( self, search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, owner_id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, starred: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1289,21 +1290,13 @@ async def read_projects_projects_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Project]]: + ) -> ApiResponse[PageProject]: """List projects 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. :param search: Substring search for project names or description :type search: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1316,6 +1309,14 @@ async def read_projects_projects_get_with_http_info( :type description: str :param starred: :type starred: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1340,16 +1341,16 @@ async def read_projects_projects_get_with_http_info( _param = self._read_projects_projects_get_serialize( search=search, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1357,7 +1358,7 @@ async def read_projects_projects_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Project]", + '200': "PageProject", '422': "HTTPValidationError" } @@ -1376,16 +1377,16 @@ async def read_projects_projects_get_with_http_info( async def read_projects_projects_get_without_preload_content( self, search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, owner_id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, starred: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1405,14 +1406,6 @@ async def read_projects_projects_get_without_preload_content( :param search: Substring search for project names or description :type search: str - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1425,6 +1418,14 @@ async def read_projects_projects_get_without_preload_content( :type description: str :param starred: :type starred: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1449,16 +1450,16 @@ async def read_projects_projects_get_without_preload_content( _param = self._read_projects_projects_get_serialize( search=search, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1466,7 +1467,7 @@ async def read_projects_projects_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Project]", + '200': "PageProject", '422': "HTTPValidationError" } @@ -1480,16 +1481,16 @@ async def read_projects_projects_get_without_preload_content( def _read_projects_projects_get_serialize( self, search, - latest, - sort_by, - page_number, - items_per_page, id, created_on, owner_id, name, description, starred, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1515,22 +1516,6 @@ def _read_projects_projects_get_serialize( _query_params.append(('search', search)) - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1564,6 +1549,22 @@ def _read_projects_projects_get_serialize( _query_params.append(('starred', starred)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/reservations_api.py b/compute_api_client/api/reservations_api.py index 224f208..1ddf637 100644 --- a/compute_api_client/api/reservations_api.py +++ b/compute_api_client/api/reservations_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,12 +23,15 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional +from compute_api_client.models.page_reservation import PageReservation from compute_api_client.models.reservation import Reservation from compute_api_client.models.reservation_in import ReservationIn @@ -599,10 +602,6 @@ def _read_reservation_reservations_id_get_serialize( @validate_call async def read_reservations_reservations_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, member_id: Optional[StrictInt] = None, start_time: Optional[datetime] = None, @@ -611,6 +610,10 @@ async def read_reservations_reservations_get( backend_id__isnull: Optional[StrictBool] = None, backend_id: Optional[StrictInt] = None, is_terminated: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -623,19 +626,11 @@ async def read_reservations_reservations_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Reservation]: + ) -> PageReservation: """List reservations Read reservations. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param member_id: @@ -652,6 +647,14 @@ async def read_reservations_reservations_get( :type backend_id: int :param is_terminated: :type is_terminated: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -675,10 +678,6 @@ async def read_reservations_reservations_get( """ # noqa: E501 _param = self._read_reservations_reservations_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, @@ -687,6 +686,10 @@ async def read_reservations_reservations_get( backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -694,7 +697,7 @@ async def read_reservations_reservations_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Reservation]", + '200': "PageReservation", '422': "HTTPValidationError" } @@ -712,10 +715,6 @@ async def read_reservations_reservations_get( @validate_call async def read_reservations_reservations_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, member_id: Optional[StrictInt] = None, start_time: Optional[datetime] = None, @@ -724,6 +723,10 @@ async def read_reservations_reservations_get_with_http_info( backend_id__isnull: Optional[StrictBool] = None, backend_id: Optional[StrictInt] = None, is_terminated: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -736,19 +739,11 @@ async def read_reservations_reservations_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Reservation]]: + ) -> ApiResponse[PageReservation]: """List reservations Read reservations. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param member_id: @@ -765,6 +760,14 @@ async def read_reservations_reservations_get_with_http_info( :type backend_id: int :param is_terminated: :type is_terminated: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -788,10 +791,6 @@ async def read_reservations_reservations_get_with_http_info( """ # noqa: E501 _param = self._read_reservations_reservations_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, @@ -800,6 +799,10 @@ async def read_reservations_reservations_get_with_http_info( backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -807,7 +810,7 @@ async def read_reservations_reservations_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Reservation]", + '200': "PageReservation", '422': "HTTPValidationError" } @@ -825,10 +828,6 @@ async def read_reservations_reservations_get_with_http_info( @validate_call async def read_reservations_reservations_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, member_id: Optional[StrictInt] = None, start_time: Optional[datetime] = None, @@ -837,6 +836,10 @@ async def read_reservations_reservations_get_without_preload_content( backend_id__isnull: Optional[StrictBool] = None, backend_id: Optional[StrictInt] = None, is_terminated: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -854,14 +857,6 @@ async def read_reservations_reservations_get_without_preload_content( Read reservations. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param member_id: @@ -878,6 +873,14 @@ async def read_reservations_reservations_get_without_preload_content( :type backend_id: int :param is_terminated: :type is_terminated: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -901,10 +904,6 @@ async def read_reservations_reservations_get_without_preload_content( """ # noqa: E501 _param = self._read_reservations_reservations_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, @@ -913,6 +912,10 @@ async def read_reservations_reservations_get_without_preload_content( backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -920,7 +923,7 @@ async def read_reservations_reservations_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Reservation]", + '200': "PageReservation", '422': "HTTPValidationError" } @@ -933,10 +936,6 @@ async def read_reservations_reservations_get_without_preload_content( def _read_reservations_reservations_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, member_id, start_time, @@ -945,6 +944,10 @@ def _read_reservations_reservations_get_serialize( backend_id__isnull, backend_id, is_terminated, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -966,22 +969,6 @@ def _read_reservations_reservations_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1032,6 +1019,22 @@ def _read_reservations_reservations_get_serialize( _query_params.append(('is_terminated', is_terminated)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/results_api.py b/compute_api_client/api/results_api.py index 68256e3..0515a3c 100644 --- a/compute_api_client/api/results_api.py +++ b/compute_api_client/api/results_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,12 +23,15 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictFloat, StrictInt, StrictStr -from typing import Any, Dict, List, Optional, Union +from typing import Any, Dict, Optional, Union +from compute_api_client.models.page_result import PageResult from compute_api_client.models.result import Result from compute_api_client.models.result_in import ResultIn @@ -859,10 +862,6 @@ def _read_result_results_id_get_serialize( async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( self, algorithm_id: StrictInt, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, job_id: Optional[StrictInt] = None, @@ -873,6 +872,10 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( shots_done__isnull: Optional[StrictBool] = None, shots_done: Optional[StrictInt] = None, results__isnull: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, body: Optional[Dict[str, Any]] = None, _request_timeout: Union[ None, @@ -886,21 +889,13 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Result]: + ) -> PageResult: """Retrieve results by algorithm ID Get results by algorithm ID. :param algorithm_id: (required) :type algorithm_id: int - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -921,6 +916,14 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( :type shots_done: int :param results__isnull: :type results__isnull: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param body: :type body: object :param _request_timeout: timeout setting for this request. If one @@ -947,10 +950,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( _param = self._read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( algorithm_id=algorithm_id, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, @@ -961,6 +960,10 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, + sort_by=sort_by, + latest=latest, + page=page, + size=size, body=body, _request_auth=_request_auth, _content_type=_content_type, @@ -969,7 +972,7 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Result]", + '200': "PageResult", '404': "HTTPNotFoundError", '422': "HTTPValidationError" @@ -989,10 +992,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get( async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_http_info( self, algorithm_id: StrictInt, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, job_id: Optional[StrictInt] = None, @@ -1003,6 +1002,10 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h shots_done__isnull: Optional[StrictBool] = None, shots_done: Optional[StrictInt] = None, results__isnull: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, body: Optional[Dict[str, Any]] = None, _request_timeout: Union[ None, @@ -1016,21 +1019,13 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Result]]: + ) -> ApiResponse[PageResult]: """Retrieve results by algorithm ID Get results by algorithm ID. :param algorithm_id: (required) :type algorithm_id: int - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1051,6 +1046,14 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h :type shots_done: int :param results__isnull: :type results__isnull: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param body: :type body: object :param _request_timeout: timeout setting for this request. If one @@ -1077,10 +1080,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h _param = self._read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( algorithm_id=algorithm_id, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, @@ -1091,6 +1090,10 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, + sort_by=sort_by, + latest=latest, + page=page, + size=size, body=body, _request_auth=_request_auth, _content_type=_content_type, @@ -1099,7 +1102,7 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Result]", + '200': "PageResult", '404': "HTTPNotFoundError", '422': "HTTPValidationError" @@ -1119,10 +1122,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_h async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_without_preload_content( self, algorithm_id: StrictInt, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, created_on: Optional[datetime] = None, job_id: Optional[StrictInt] = None, @@ -1133,6 +1132,10 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou shots_done__isnull: Optional[StrictBool] = None, shots_done: Optional[StrictInt] = None, results__isnull: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, body: Optional[Dict[str, Any]] = None, _request_timeout: Union[ None, @@ -1153,14 +1156,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou :param algorithm_id: (required) :type algorithm_id: int - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param created_on: @@ -1181,6 +1176,14 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou :type shots_done: int :param results__isnull: :type results__isnull: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param body: :type body: object :param _request_timeout: timeout setting for this request. If one @@ -1207,10 +1210,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou _param = self._read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( algorithm_id=algorithm_id, - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, @@ -1221,6 +1220,10 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, + sort_by=sort_by, + latest=latest, + page=page, + size=size, body=body, _request_auth=_request_auth, _content_type=_content_type, @@ -1229,7 +1232,7 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Result]", + '200': "PageResult", '404': "HTTPNotFoundError", '422': "HTTPValidationError" @@ -1244,10 +1247,6 @@ async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_withou def _read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( self, algorithm_id, - latest, - sort_by, - page_number, - items_per_page, id, created_on, job_id, @@ -1258,6 +1257,10 @@ def _read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( shots_done__isnull, shots_done, results__isnull, + sort_by, + latest, + page, + size, body, _request_auth, _content_type, @@ -1282,22 +1285,6 @@ def _read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( if algorithm_id is not None: _path_params['algorithm_id'] = algorithm_id # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1347,6 +1334,22 @@ def _read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( _query_params.append(('results__isnull', results__isnull)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter @@ -1402,6 +1405,10 @@ def _read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize( async def read_results_by_job_id_results_job_job_id_get( self, job_id: StrictInt, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, + sort_by: Optional[StrictStr] = None, + latest: Optional[StrictBool] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1414,13 +1421,21 @@ async def read_results_by_job_id_results_job_job_id_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Result]: + ) -> PageResult: """Retrieve results by job ID Get results by job ID. :param job_id: (required) :type job_id: int + :param page: Page number + :type page: int + :param size: Page size + :type size: int + :param sort_by: + :type sort_by: str + :param latest: + :type latest: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1445,6 +1460,10 @@ async def read_results_by_job_id_results_job_job_id_get( _param = self._read_results_by_job_id_results_job_job_id_get_serialize( job_id=job_id, + page=page, + size=size, + sort_by=sort_by, + latest=latest, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1452,7 +1471,7 @@ async def read_results_by_job_id_results_job_job_id_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Result]", + '200': "PageResult", '404': "HTTPNotFoundError", '422': "HTTPValidationError" @@ -1472,6 +1491,10 @@ async def read_results_by_job_id_results_job_job_id_get( async def read_results_by_job_id_results_job_job_id_get_with_http_info( self, job_id: StrictInt, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, + sort_by: Optional[StrictStr] = None, + latest: Optional[StrictBool] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1484,13 +1507,21 @@ async def read_results_by_job_id_results_job_job_id_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Result]]: + ) -> ApiResponse[PageResult]: """Retrieve results by job ID Get results by job ID. :param job_id: (required) :type job_id: int + :param page: Page number + :type page: int + :param size: Page size + :type size: int + :param sort_by: + :type sort_by: str + :param latest: + :type latest: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1515,6 +1546,10 @@ async def read_results_by_job_id_results_job_job_id_get_with_http_info( _param = self._read_results_by_job_id_results_job_job_id_get_serialize( job_id=job_id, + page=page, + size=size, + sort_by=sort_by, + latest=latest, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1522,7 +1557,7 @@ async def read_results_by_job_id_results_job_job_id_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Result]", + '200': "PageResult", '404': "HTTPNotFoundError", '422': "HTTPValidationError" @@ -1542,6 +1577,10 @@ async def read_results_by_job_id_results_job_job_id_get_with_http_info( async def read_results_by_job_id_results_job_job_id_get_without_preload_content( self, job_id: StrictInt, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, + sort_by: Optional[StrictStr] = None, + latest: Optional[StrictBool] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1561,6 +1600,14 @@ async def read_results_by_job_id_results_job_job_id_get_without_preload_content( :param job_id: (required) :type job_id: int + :param page: Page number + :type page: int + :param size: Page size + :type size: int + :param sort_by: + :type sort_by: str + :param latest: + :type latest: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1585,6 +1632,10 @@ async def read_results_by_job_id_results_job_job_id_get_without_preload_content( _param = self._read_results_by_job_id_results_job_job_id_get_serialize( job_id=job_id, + page=page, + size=size, + sort_by=sort_by, + latest=latest, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1592,7 +1643,7 @@ async def read_results_by_job_id_results_job_job_id_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Result]", + '200': "PageResult", '404': "HTTPNotFoundError", '422': "HTTPValidationError" @@ -1607,6 +1658,10 @@ async def read_results_by_job_id_results_job_job_id_get_without_preload_content( def _read_results_by_job_id_results_job_job_id_get_serialize( self, job_id, + page, + size, + sort_by, + latest, _request_auth, _content_type, _headers, @@ -1630,6 +1685,22 @@ def _read_results_by_job_id_results_job_job_id_get_serialize( if job_id is not None: _path_params['job_id'] = job_id # process the query parameters + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/teams_api.py b/compute_api_client/api/teams_api.py index b7f5014..365850c 100644 --- a/compute_api_client/api/teams_api.py +++ b/compute_api_client/api/teams_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,10 +23,13 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional +from compute_api_client.models.page_team import PageTeam from compute_api_client.models.team import Team from compute_api_client.api_client import ApiClient @@ -318,14 +321,14 @@ def _read_team_teams_id_get_serialize( @validate_call async def read_teams_teams_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, slug: Optional[StrictStr] = None, individual_user: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -338,19 +341,11 @@ async def read_teams_teams_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Team]: + ) -> PageTeam: """List teams Read teams. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -359,6 +354,14 @@ async def read_teams_teams_get( :type slug: str :param individual_user: :type individual_user: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -382,14 +385,14 @@ async def read_teams_teams_get( """ # noqa: E501 _param = self._read_teams_teams_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, slug=slug, individual_user=individual_user, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -397,7 +400,7 @@ async def read_teams_teams_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Team]", + '200': "PageTeam", '422': "HTTPValidationError" } @@ -415,14 +418,14 @@ async def read_teams_teams_get( @validate_call async def read_teams_teams_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, slug: Optional[StrictStr] = None, individual_user: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -435,19 +438,11 @@ async def read_teams_teams_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Team]]: + ) -> ApiResponse[PageTeam]: """List teams Read teams. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -456,6 +451,14 @@ async def read_teams_teams_get_with_http_info( :type slug: str :param individual_user: :type individual_user: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -479,14 +482,14 @@ async def read_teams_teams_get_with_http_info( """ # noqa: E501 _param = self._read_teams_teams_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, slug=slug, individual_user=individual_user, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -494,7 +497,7 @@ async def read_teams_teams_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Team]", + '200': "PageTeam", '422': "HTTPValidationError" } @@ -512,14 +515,14 @@ async def read_teams_teams_get_with_http_info( @validate_call async def read_teams_teams_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, slug: Optional[StrictStr] = None, individual_user: Optional[StrictBool] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -537,14 +540,6 @@ async def read_teams_teams_get_without_preload_content( Read teams. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param name: @@ -553,6 +548,14 @@ async def read_teams_teams_get_without_preload_content( :type slug: str :param individual_user: :type individual_user: bool + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -576,14 +579,14 @@ async def read_teams_teams_get_without_preload_content( """ # noqa: E501 _param = self._read_teams_teams_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, name=name, slug=slug, individual_user=individual_user, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -591,7 +594,7 @@ async def read_teams_teams_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Team]", + '200': "PageTeam", '422': "HTTPValidationError" } @@ -604,14 +607,14 @@ async def read_teams_teams_get_without_preload_content( def _read_teams_teams_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, name, slug, individual_user, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -633,22 +636,6 @@ def _read_teams_teams_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -665,6 +652,22 @@ def _read_teams_teams_get_serialize( _query_params.append(('individual_user', individual_user)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/transactions_api.py b/compute_api_client/api/transactions_api.py index 1491a5e..d798fb5 100644 --- a/compute_api_client/api/transactions_api.py +++ b/compute_api_client/api/transactions_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,13 +23,16 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from datetime import datetime from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional from compute_api_client.models.domain import Domain +from compute_api_client.models.page_transaction import PageTransaction from compute_api_client.models.transaction import Transaction from compute_api_client.api_client import ApiClient @@ -321,10 +324,6 @@ def _read_transaction_transactions_id_get_serialize( @validate_call async def read_transactions_transactions_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, domain__isnull: Optional[StrictBool] = None, domain: Optional[Domain] = None, @@ -335,6 +334,10 @@ async def read_transactions_transactions_get( member_id: Optional[StrictInt] = None, change: Optional[StrictInt] = None, timestamp: Optional[datetime] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -347,19 +350,11 @@ async def read_transactions_transactions_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[Transaction]: + ) -> PageTransaction: """List transactions Read transactions. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param domain__isnull: @@ -380,6 +375,14 @@ async def read_transactions_transactions_get( :type change: int :param timestamp: :type timestamp: datetime + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -403,10 +406,6 @@ async def read_transactions_transactions_get( """ # noqa: E501 _param = self._read_transactions_transactions_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, @@ -417,6 +416,10 @@ async def read_transactions_transactions_get( member_id=member_id, change=change, timestamp=timestamp, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -424,7 +427,7 @@ async def read_transactions_transactions_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Transaction]", + '200': "PageTransaction", '422': "HTTPValidationError" } @@ -442,10 +445,6 @@ async def read_transactions_transactions_get( @validate_call async def read_transactions_transactions_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, domain__isnull: Optional[StrictBool] = None, domain: Optional[Domain] = None, @@ -456,6 +455,10 @@ async def read_transactions_transactions_get_with_http_info( member_id: Optional[StrictInt] = None, change: Optional[StrictInt] = None, timestamp: Optional[datetime] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -468,19 +471,11 @@ async def read_transactions_transactions_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[Transaction]]: + ) -> ApiResponse[PageTransaction]: """List transactions Read transactions. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param domain__isnull: @@ -501,6 +496,14 @@ async def read_transactions_transactions_get_with_http_info( :type change: int :param timestamp: :type timestamp: datetime + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -524,10 +527,6 @@ async def read_transactions_transactions_get_with_http_info( """ # noqa: E501 _param = self._read_transactions_transactions_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, @@ -538,6 +537,10 @@ async def read_transactions_transactions_get_with_http_info( member_id=member_id, change=change, timestamp=timestamp, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -545,7 +548,7 @@ async def read_transactions_transactions_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Transaction]", + '200': "PageTransaction", '422': "HTTPValidationError" } @@ -563,10 +566,6 @@ async def read_transactions_transactions_get_with_http_info( @validate_call async def read_transactions_transactions_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, domain__isnull: Optional[StrictBool] = None, domain: Optional[Domain] = None, @@ -577,6 +576,10 @@ async def read_transactions_transactions_get_without_preload_content( member_id: Optional[StrictInt] = None, change: Optional[StrictInt] = None, timestamp: Optional[datetime] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -594,14 +597,6 @@ async def read_transactions_transactions_get_without_preload_content( Read transactions. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param domain__isnull: @@ -622,6 +617,14 @@ async def read_transactions_transactions_get_without_preload_content( :type change: int :param timestamp: :type timestamp: datetime + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -645,10 +648,6 @@ async def read_transactions_transactions_get_without_preload_content( """ # noqa: E501 _param = self._read_transactions_transactions_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, @@ -659,6 +658,10 @@ async def read_transactions_transactions_get_without_preload_content( member_id=member_id, change=change, timestamp=timestamp, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -666,7 +669,7 @@ async def read_transactions_transactions_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Transaction]", + '200': "PageTransaction", '422': "HTTPValidationError" } @@ -679,10 +682,6 @@ async def read_transactions_transactions_get_without_preload_content( def _read_transactions_transactions_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, domain__isnull, domain, @@ -693,6 +692,10 @@ def _read_transactions_transactions_get_serialize( member_id, change, timestamp, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -714,22 +717,6 @@ def _read_transactions_transactions_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -779,6 +766,22 @@ def _read_transactions_transactions_get_serialize( else: _query_params.append(('timestamp', timestamp)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api/users_api.py b/compute_api_client/api/users_api.py index 7eb079e..11252a5 100644 --- a/compute_api_client/api/users_api.py +++ b/compute_api_client/api/users_api.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,10 +23,13 @@ except ImportError: from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from pydantic import StrictBool, StrictInt, StrictStr -from typing import List, Optional +from typing import Optional +from compute_api_client.models.page_user import PageUser from compute_api_client.models.user import User from compute_api_client.models.user_in import UserIn @@ -856,10 +859,6 @@ def _read_user_users_id_get_serialize( @validate_call async def read_users_users_get( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, full_name: Optional[StrictStr] = None, email: Optional[StrictStr] = None, @@ -868,6 +867,10 @@ async def read_users_users_get( is_active: Optional[StrictBool] = None, is_confirmed: Optional[StrictBool] = None, oidc_sub: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -880,19 +883,11 @@ async def read_users_users_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[User]: + ) -> PageUser: """List users Read users. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param full_name: @@ -909,6 +904,14 @@ async def read_users_users_get( :type is_confirmed: bool :param oidc_sub: :type oidc_sub: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -932,10 +935,6 @@ async def read_users_users_get( """ # noqa: E501 _param = self._read_users_users_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, full_name=full_name, email=email, @@ -944,6 +943,10 @@ async def read_users_users_get( is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -951,7 +954,7 @@ async def read_users_users_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[User]", + '200': "PageUser", '422': "HTTPValidationError" } @@ -969,10 +972,6 @@ async def read_users_users_get( @validate_call async def read_users_users_get_with_http_info( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, full_name: Optional[StrictStr] = None, email: Optional[StrictStr] = None, @@ -981,6 +980,10 @@ async def read_users_users_get_with_http_info( is_active: Optional[StrictBool] = None, is_confirmed: Optional[StrictBool] = None, oidc_sub: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -993,19 +996,11 @@ async def read_users_users_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[User]]: + ) -> ApiResponse[PageUser]: """List users Read users. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param full_name: @@ -1022,6 +1017,14 @@ async def read_users_users_get_with_http_info( :type is_confirmed: bool :param oidc_sub: :type oidc_sub: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1045,10 +1048,6 @@ async def read_users_users_get_with_http_info( """ # noqa: E501 _param = self._read_users_users_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, full_name=full_name, email=email, @@ -1057,6 +1056,10 @@ async def read_users_users_get_with_http_info( is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1064,7 +1067,7 @@ async def read_users_users_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[User]", + '200': "PageUser", '422': "HTTPValidationError" } @@ -1082,10 +1085,6 @@ async def read_users_users_get_with_http_info( @validate_call async def read_users_users_get_without_preload_content( self, - latest: Optional[StrictBool] = None, - sort_by: Optional[StrictStr] = None, - page_number: Optional[StrictInt] = None, - items_per_page: Optional[StrictInt] = None, id: Optional[StrictInt] = None, full_name: Optional[StrictStr] = None, email: Optional[StrictStr] = None, @@ -1094,6 +1093,10 @@ async def read_users_users_get_without_preload_content( is_active: Optional[StrictBool] = None, is_confirmed: Optional[StrictBool] = None, oidc_sub: Optional[StrictStr] = None, + sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None, + latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None, + page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None, + size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1111,14 +1114,6 @@ async def read_users_users_get_without_preload_content( Read users. - :param latest: - :type latest: bool - :param sort_by: - :type sort_by: str - :param page_number: - :type page_number: int - :param items_per_page: - :type items_per_page: int :param id: :type id: int :param full_name: @@ -1135,6 +1130,14 @@ async def read_users_users_get_without_preload_content( :type is_confirmed: bool :param oidc_sub: :type oidc_sub: str + :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. + :type sort_by: str + :param latest: If True gets the most recently created object. + :type latest: bool + :param page: Page number + :type page: int + :param size: Page size + :type size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1158,10 +1161,6 @@ async def read_users_users_get_without_preload_content( """ # noqa: E501 _param = self._read_users_users_get_serialize( - latest=latest, - sort_by=sort_by, - page_number=page_number, - items_per_page=items_per_page, id=id, full_name=full_name, email=email, @@ -1170,6 +1169,10 @@ async def read_users_users_get_without_preload_content( is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, + sort_by=sort_by, + latest=latest, + page=page, + size=size, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1177,7 +1180,7 @@ async def read_users_users_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[User]", + '200': "PageUser", '422': "HTTPValidationError" } @@ -1190,10 +1193,6 @@ async def read_users_users_get_without_preload_content( def _read_users_users_get_serialize( self, - latest, - sort_by, - page_number, - items_per_page, id, full_name, email, @@ -1202,6 +1201,10 @@ def _read_users_users_get_serialize( is_active, is_confirmed, oidc_sub, + sort_by, + latest, + page, + size, _request_auth, _content_type, _headers, @@ -1223,22 +1226,6 @@ def _read_users_users_get_serialize( # process the path parameters # process the query parameters - if latest is not None: - - _query_params.append(('latest', latest)) - - if sort_by is not None: - - _query_params.append(('sort_by', sort_by)) - - if page_number is not None: - - _query_params.append(('page_number', page_number)) - - if items_per_page is not None: - - _query_params.append(('items_per_page', items_per_page)) - if id is not None: _query_params.append(('id', id)) @@ -1271,6 +1258,22 @@ def _read_users_users_get_serialize( _query_params.append(('oidc_sub', oidc_sub)) + if sort_by is not None: + + _query_params.append(('sort_by', sort_by)) + + if latest is not None: + + _query_params.append(('latest', latest)) + + if page is not None: + + _query_params.append(('page', page)) + + if size is not None: + + _query_params.append(('size', size)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/compute_api_client/api_client.py b/compute_api_client/api_client.py index 8f03518..4bc9614 100644 --- a/compute_api_client/api_client.py +++ b/compute_api_client/api_client.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/configuration.py b/compute_api_client/configuration.py index 971ba99..077ca46 100644 --- a/compute_api_client/configuration.py +++ b/compute_api_client/configuration.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/docs/AlgorithmsApi.md b/compute_api_client/docs/AlgorithmsApi.md index fc32d44..3d401bc 100644 --- a/compute_api_client/docs/AlgorithmsApi.md +++ b/compute_api_client/docs/AlgorithmsApi.md @@ -244,7 +244,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_algorithms_algorithms_get** -> List[Algorithm] read_algorithms_algorithms_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name) +> PageAlgorithm read_algorithms_algorithms_get(search=search, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name, sort_by=sort_by, latest=latest, page=page, size=size) List algorithms @@ -257,8 +257,8 @@ List algorithms. import time import os import compute_api_client -from compute_api_client.models.algorithm import Algorithm from compute_api_client.models.algorithm_type import AlgorithmType +from compute_api_client.models.page_algorithm import PageAlgorithm from compute_api_client.models.share_type import ShareType from compute_api_client.rest import ApiException from pprint import pprint @@ -281,10 +281,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.AlgorithmsApi(api_client) search = 'search_example' # str | Substring search for algorithm names (optional) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) project_id = 56 # int | (optional) type = compute_api_client.AlgorithmType() # AlgorithmType | (optional) @@ -292,10 +288,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: link__isnull = True # bool | (optional) link = 'link_example' # str | (optional) name = 'name_example' # str | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List algorithms - api_response = await api_instance.read_algorithms_algorithms_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name) + api_response = await api_instance.read_algorithms_algorithms_get(search=search, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of AlgorithmsApi->read_algorithms_algorithms_get:\n") pprint(api_response) except Exception as e: @@ -309,10 +309,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **search** | **str**| Substring search for algorithm names | [optional] - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **project_id** | **int**| | [optional] **type** | [**AlgorithmType**](.md)| | [optional] @@ -320,10 +316,14 @@ Name | Type | Description | Notes **link__isnull** | **bool**| | [optional] **link** | **str**| | [optional] **name** | **str**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Algorithm]**](Algorithm.md) +[**PageAlgorithm**](PageAlgorithm.md) ### Authorization diff --git a/compute_api_client/docs/BackendApi.md b/compute_api_client/docs/BackendApi.md index ba01acd..a9b6175 100644 --- a/compute_api_client/docs/BackendApi.md +++ b/compute_api_client/docs/BackendApi.md @@ -238,7 +238,7 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_backends_backends_get** -> List[Backend] read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat) +> PageBackend read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size) List backends @@ -251,8 +251,8 @@ Read backends. import time import os import compute_api_client -from compute_api_client.models.backend import Backend from compute_api_client.models.backend_status import BackendStatus +from compute_api_client.models.page_backend import PageBackend from compute_api_client.rest import ApiException from pprint import pprint @@ -273,20 +273,20 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.BackendApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) name = 'name_example' # str | (optional) location = 'location_example' # str | (optional) backend_type_id = 56 # int | (optional) status = compute_api_client.BackendStatus() # BackendStatus | (optional) last_heartbeat = '2013-10-20T19:20:30+01:00' # datetime | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List backends - api_response = await api_instance.read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat) + api_response = await api_instance.read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of BackendApi->read_backends_backends_get:\n") pprint(api_response) except Exception as e: @@ -299,20 +299,20 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **name** | **str**| | [optional] **location** | **str**| | [optional] **backend_type_id** | **int**| | [optional] **status** | [**BackendStatus**](.md)| | [optional] **last_heartbeat** | **datetime**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Backend]**](Backend.md) +[**PageBackend**](PageBackend.md) ### Authorization diff --git a/compute_api_client/docs/BackendTypesApi.md b/compute_api_client/docs/BackendTypesApi.md index f993dd9..2c88ef5 100644 --- a/compute_api_client/docs/BackendTypesApi.md +++ b/compute_api_client/docs/BackendTypesApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_backend_types_backend_types_get** -> List[BackendType] read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots) +> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size) List backend types @@ -99,7 +99,7 @@ import time import os import compute_api_client from compute_api_client.models.backend_status import BackendStatus -from compute_api_client.models.backend_type import BackendType +from compute_api_client.models.page_backend_type import PageBackendType from compute_api_client.rest import ApiException from pprint import pprint @@ -120,10 +120,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.BackendTypesApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) name = 'name_example' # str | (optional) infrastructure = 'infrastructure_example' # str | (optional) @@ -133,10 +129,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: status = compute_api_client.BackendStatus() # BackendStatus | (optional) default_number_of_shots = 56 # int | (optional) max_number_of_shots = 56 # int | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List backend types - api_response = await api_instance.read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots) + api_response = await api_instance.read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n") pprint(api_response) except Exception as e: @@ -149,10 +149,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **name** | **str**| | [optional] **infrastructure** | **str**| | [optional] @@ -162,10 +158,14 @@ Name | Type | Description | Notes **status** | [**BackendStatus**](.md)| | [optional] **default_number_of_shots** | **int**| | [optional] **max_number_of_shots** | **int**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[BackendType]**](BackendType.md) +[**PageBackendType**](PageBackendType.md) ### Authorization diff --git a/compute_api_client/docs/BatchJobsApi.md b/compute_api_client/docs/BatchJobsApi.md index 30f4daf..7c350e9 100644 --- a/compute_api_client/docs/BatchJobsApi.md +++ b/compute_api_client/docs/BatchJobsApi.md @@ -403,7 +403,7 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_batch_jobs_batch_jobs_get** -> List[BatchJob] read_batch_jobs_batch_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type) +> PageBatchJob read_batch_jobs_batch_jobs_get(id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, sort_by=sort_by, latest=latest, page=page, size=size) List batch jobs @@ -417,8 +417,8 @@ import time import os import compute_api_client from compute_api_client.models.algorithm_type import AlgorithmType -from compute_api_client.models.batch_job import BatchJob from compute_api_client.models.batch_job_status import BatchJobStatus +from compute_api_client.models.page_batch_job import PageBatchJob from compute_api_client.rest import ApiException from pprint import pprint @@ -439,10 +439,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.BatchJobsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional) status = compute_api_client.BatchJobStatus() # BatchJobStatus | (optional) @@ -456,10 +452,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: finished_at__isnull = True # bool | (optional) finished_at = '2013-10-20T19:20:30+01:00' # datetime | (optional) aggregated_algorithm_type = compute_api_client.AlgorithmType() # AlgorithmType | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List batch jobs - api_response = await api_instance.read_batch_jobs_batch_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type) + api_response = await api_instance.read_batch_jobs_batch_jobs_get(id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of BatchJobsApi->read_batch_jobs_batch_jobs_get:\n") pprint(api_response) except Exception as e: @@ -472,10 +472,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **created_on** | **datetime**| | [optional] **status** | [**BatchJobStatus**](.md)| | [optional] @@ -489,10 +485,14 @@ Name | Type | Description | Notes **finished_at__isnull** | **bool**| | [optional] **finished_at** | **datetime**| | [optional] **aggregated_algorithm_type** | [**AlgorithmType**](.md)| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[BatchJob]**](BatchJob.md) +[**PageBatchJob**](PageBatchJob.md) ### Authorization diff --git a/compute_api_client/docs/CommitsApi.md b/compute_api_client/docs/CommitsApi.md index 7989c4b..c0fe195 100644 --- a/compute_api_client/docs/CommitsApi.md +++ b/compute_api_client/docs/CommitsApi.md @@ -243,7 +243,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_commits_commits_get** -> List[Commit] read_commits_commits_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id) +> PageCommit read_commits_commits_get(id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, sort_by=sort_by, latest=latest, page=page, size=size) List commits @@ -256,7 +256,7 @@ List commits. import time import os import compute_api_client -from compute_api_client.models.commit import Commit +from compute_api_client.models.page_commit import PageCommit from compute_api_client.rest import ApiException from pprint import pprint @@ -277,19 +277,19 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.CommitsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional) hash = 'hash_example' # str | (optional) description = 'description_example' # str | (optional) algorithm_id = 56 # int | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List commits - api_response = await api_instance.read_commits_commits_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id) + api_response = await api_instance.read_commits_commits_get(id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of CommitsApi->read_commits_commits_get:\n") pprint(api_response) except Exception as e: @@ -302,19 +302,19 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **created_on** | **datetime**| | [optional] **hash** | **str**| | [optional] **description** | **str**| | [optional] **algorithm_id** | **int**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Commit]**](Commit.md) +[**PageCommit**](PageCommit.md) ### Authorization diff --git a/compute_api_client/docs/FilesApi.md b/compute_api_client/docs/FilesApi.md index aefec89..f7cf507 100644 --- a/compute_api_client/docs/FilesApi.md +++ b/compute_api_client/docs/FilesApi.md @@ -243,7 +243,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_files_files_get** -> List[File] read_files_files_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated) +> PageFile read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, sort_by=sort_by, latest=latest, page=page, size=size) List files @@ -257,7 +257,7 @@ import time import os import compute_api_client from compute_api_client.models.compile_stage import CompileStage -from compute_api_client.models.file import File +from compute_api_client.models.page_file import PageFile from compute_api_client.rest import ApiException from pprint import pprint @@ -278,20 +278,20 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.FilesApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) commit_id = 56 # int | (optional) content = 'content_example' # str | (optional) language_id = 56 # int | (optional) compile_stage = compute_api_client.CompileStage() # CompileStage | (optional) generated = True # bool | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List files - api_response = await api_instance.read_files_files_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated) + api_response = await api_instance.read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of FilesApi->read_files_files_get:\n") pprint(api_response) except Exception as e: @@ -304,20 +304,20 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **commit_id** | **int**| | [optional] **content** | **str**| | [optional] **language_id** | **int**| | [optional] **compile_stage** | [**CompileStage**](.md)| | [optional] **generated** | **bool**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[File]**](File.md) +[**PageFile**](PageFile.md) ### Authorization diff --git a/compute_api_client/docs/JobsApi.md b/compute_api_client/docs/JobsApi.md index 9fdcae9..540169d 100644 --- a/compute_api_client/docs/JobsApi.md +++ b/compute_api_client/docs/JobsApi.md @@ -244,7 +244,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_jobs_jobs_get** -> List[Job] read_jobs_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, file_id=file_id, algorithm_type=algorithm_type, status=status, batch_job_id=batch_job_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots) +> PageJob read_jobs_jobs_get(id=id, created_on=created_on, file_id=file_id, algorithm_type=algorithm_type, status=status, batch_job_id=batch_job_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size) List jobs @@ -259,8 +259,8 @@ import time import os import compute_api_client from compute_api_client.models.algorithm_type import AlgorithmType -from compute_api_client.models.job import Job from compute_api_client.models.job_status import JobStatus +from compute_api_client.models.page_job import PageJob from compute_api_client.rest import ApiException from pprint import pprint @@ -287,10 +287,6 @@ configuration.api_key['backend'] = os.environ["API_KEY"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.JobsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional) file_id = 56 # int | (optional) @@ -303,10 +299,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: finished_at = '2013-10-20T19:20:30+01:00' # datetime | (optional) number_of_shots__isnull = True # bool | (optional) number_of_shots = 56 # int | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List jobs - api_response = await api_instance.read_jobs_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, file_id=file_id, algorithm_type=algorithm_type, status=status, batch_job_id=batch_job_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots) + api_response = await api_instance.read_jobs_jobs_get(id=id, created_on=created_on, file_id=file_id, algorithm_type=algorithm_type, status=status, batch_job_id=batch_job_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of JobsApi->read_jobs_jobs_get:\n") pprint(api_response) except Exception as e: @@ -319,10 +319,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **created_on** | **datetime**| | [optional] **file_id** | **int**| | [optional] @@ -335,10 +331,14 @@ Name | Type | Description | Notes **finished_at** | **datetime**| | [optional] **number_of_shots__isnull** | **bool**| | [optional] **number_of_shots** | **int**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Job]**](Job.md) +[**PageJob**](PageJob.md) ### Authorization diff --git a/compute_api_client/docs/LanguagesApi.md b/compute_api_client/docs/LanguagesApi.md index 34d26ab..4f723e5 100644 --- a/compute_api_client/docs/LanguagesApi.md +++ b/compute_api_client/docs/LanguagesApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_languages_languages_get** -> List[Language] read_languages_languages_get(q=q, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, version=version) +> PageLanguage read_languages_languages_get(q=q, id=id, name=name, version=version, sort_by=sort_by, latest=latest, page=page, size=size) List languages @@ -98,7 +98,7 @@ List languages. import time import os import compute_api_client -from compute_api_client.models.language import Language +from compute_api_client.models.page_language import PageLanguage from compute_api_client.rest import ApiException from pprint import pprint @@ -120,17 +120,17 @@ async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.LanguagesApi(api_client) q = 'q_example' # str | (optional) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) name = 'name_example' # str | (optional) version = 'version_example' # str | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List languages - api_response = await api_instance.read_languages_languages_get(q=q, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, version=version) + api_response = await api_instance.read_languages_languages_get(q=q, id=id, name=name, version=version, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of LanguagesApi->read_languages_languages_get:\n") pprint(api_response) except Exception as e: @@ -144,17 +144,17 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **q** | **str**| | [optional] - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **name** | **str**| | [optional] **version** | **str**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Language]**](Language.md) +[**PageLanguage**](PageLanguage.md) ### Authorization diff --git a/compute_api_client/docs/MembersApi.md b/compute_api_client/docs/MembersApi.md index 2382664..b603954 100644 --- a/compute_api_client/docs/MembersApi.md +++ b/compute_api_client/docs/MembersApi.md @@ -236,7 +236,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_members_members_get** -> List[Member] read_members_members_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, team_id=team_id, role=role, is_active=is_active) +> PageMember read_members_members_get(id=id, team_id=team_id, role=role, is_active=is_active, sort_by=sort_by, latest=latest, page=page, size=size) List members @@ -249,7 +249,7 @@ Read members. import time import os import compute_api_client -from compute_api_client.models.member import Member +from compute_api_client.models.page_member import PageMember from compute_api_client.models.role import Role from compute_api_client.rest import ApiException from pprint import pprint @@ -271,18 +271,18 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.MembersApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) team_id = 56 # int | (optional) role = compute_api_client.Role() # Role | (optional) is_active = True # bool | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List members - api_response = await api_instance.read_members_members_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, team_id=team_id, role=role, is_active=is_active) + api_response = await api_instance.read_members_members_get(id=id, team_id=team_id, role=role, is_active=is_active, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of MembersApi->read_members_members_get:\n") pprint(api_response) except Exception as e: @@ -295,18 +295,18 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **team_id** | **int**| | [optional] **role** | [**Role**](.md)| | [optional] **is_active** | **bool**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Member]**](Member.md) +[**PageMember**](PageMember.md) ### Authorization diff --git a/compute_api_client/docs/MetadataApi.md b/compute_api_client/docs/MetadataApi.md index e0a66a4..297e3b1 100644 --- a/compute_api_client/docs/MetadataApi.md +++ b/compute_api_client/docs/MetadataApi.md @@ -90,7 +90,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_metadata_by_backend_id_metadata_backend_backend_id_get** -> List[Metadata] read_metadata_by_backend_id_metadata_backend_backend_id_get(backend_id) +> PageMetadata read_metadata_by_backend_id_metadata_backend_backend_id_get(backend_id, sort_by=sort_by, latest=latest, page=page, size=size) Retrieve metadata by backend ID @@ -103,7 +103,7 @@ Get metadata by job ID. import time import os import compute_api_client -from compute_api_client.models.metadata import Metadata +from compute_api_client.models.page_metadata import PageMetadata from compute_api_client.rest import ApiException from pprint import pprint @@ -125,10 +125,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.MetadataApi(api_client) backend_id = 56 # int | + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # Retrieve metadata by backend ID - api_response = await api_instance.read_metadata_by_backend_id_metadata_backend_backend_id_get(backend_id) + api_response = await api_instance.read_metadata_by_backend_id_metadata_backend_backend_id_get(backend_id, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of MetadataApi->read_metadata_by_backend_id_metadata_backend_backend_id_get:\n") pprint(api_response) except Exception as e: @@ -142,10 +146,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **backend_id** | **int**| | + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Metadata]**](Metadata.md) +[**PageMetadata**](PageMetadata.md) ### Authorization diff --git a/compute_api_client/docs/PageAlgorithm.md b/compute_api_client/docs/PageAlgorithm.md new file mode 100644 index 0000000..e79f4d4 --- /dev/null +++ b/compute_api_client/docs/PageAlgorithm.md @@ -0,0 +1,32 @@ +# PageAlgorithm + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Algorithm]**](Algorithm.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_algorithm import PageAlgorithm + +# TODO update the JSON string below +json = "{}" +# create an instance of PageAlgorithm from a JSON string +page_algorithm_instance = PageAlgorithm.from_json(json) +# print the JSON string representation of the object +print PageAlgorithm.to_json() + +# convert the object into a dict +page_algorithm_dict = page_algorithm_instance.to_dict() +# create an instance of PageAlgorithm from a dict +page_algorithm_form_dict = page_algorithm.from_dict(page_algorithm_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageBackend.md b/compute_api_client/docs/PageBackend.md new file mode 100644 index 0000000..e694042 --- /dev/null +++ b/compute_api_client/docs/PageBackend.md @@ -0,0 +1,32 @@ +# PageBackend + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Backend]**](Backend.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_backend import PageBackend + +# TODO update the JSON string below +json = "{}" +# create an instance of PageBackend from a JSON string +page_backend_instance = PageBackend.from_json(json) +# print the JSON string representation of the object +print PageBackend.to_json() + +# convert the object into a dict +page_backend_dict = page_backend_instance.to_dict() +# create an instance of PageBackend from a dict +page_backend_form_dict = page_backend.from_dict(page_backend_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageBackendType.md b/compute_api_client/docs/PageBackendType.md new file mode 100644 index 0000000..9bf0ee6 --- /dev/null +++ b/compute_api_client/docs/PageBackendType.md @@ -0,0 +1,32 @@ +# PageBackendType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[BackendType]**](BackendType.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_backend_type import PageBackendType + +# TODO update the JSON string below +json = "{}" +# create an instance of PageBackendType from a JSON string +page_backend_type_instance = PageBackendType.from_json(json) +# print the JSON string representation of the object +print PageBackendType.to_json() + +# convert the object into a dict +page_backend_type_dict = page_backend_type_instance.to_dict() +# create an instance of PageBackendType from a dict +page_backend_type_form_dict = page_backend_type.from_dict(page_backend_type_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageBatchJob.md b/compute_api_client/docs/PageBatchJob.md new file mode 100644 index 0000000..0110eb1 --- /dev/null +++ b/compute_api_client/docs/PageBatchJob.md @@ -0,0 +1,32 @@ +# PageBatchJob + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[BatchJob]**](BatchJob.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_batch_job import PageBatchJob + +# TODO update the JSON string below +json = "{}" +# create an instance of PageBatchJob from a JSON string +page_batch_job_instance = PageBatchJob.from_json(json) +# print the JSON string representation of the object +print PageBatchJob.to_json() + +# convert the object into a dict +page_batch_job_dict = page_batch_job_instance.to_dict() +# create an instance of PageBatchJob from a dict +page_batch_job_form_dict = page_batch_job.from_dict(page_batch_job_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageCommit.md b/compute_api_client/docs/PageCommit.md new file mode 100644 index 0000000..4bc84c4 --- /dev/null +++ b/compute_api_client/docs/PageCommit.md @@ -0,0 +1,32 @@ +# PageCommit + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Commit]**](Commit.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_commit import PageCommit + +# TODO update the JSON string below +json = "{}" +# create an instance of PageCommit from a JSON string +page_commit_instance = PageCommit.from_json(json) +# print the JSON string representation of the object +print PageCommit.to_json() + +# convert the object into a dict +page_commit_dict = page_commit_instance.to_dict() +# create an instance of PageCommit from a dict +page_commit_form_dict = page_commit.from_dict(page_commit_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageFile.md b/compute_api_client/docs/PageFile.md new file mode 100644 index 0000000..034c15c --- /dev/null +++ b/compute_api_client/docs/PageFile.md @@ -0,0 +1,32 @@ +# PageFile + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[File]**](File.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_file import PageFile + +# TODO update the JSON string below +json = "{}" +# create an instance of PageFile from a JSON string +page_file_instance = PageFile.from_json(json) +# print the JSON string representation of the object +print PageFile.to_json() + +# convert the object into a dict +page_file_dict = page_file_instance.to_dict() +# create an instance of PageFile from a dict +page_file_form_dict = page_file.from_dict(page_file_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageJob.md b/compute_api_client/docs/PageJob.md new file mode 100644 index 0000000..cb17e03 --- /dev/null +++ b/compute_api_client/docs/PageJob.md @@ -0,0 +1,32 @@ +# PageJob + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Job]**](Job.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_job import PageJob + +# TODO update the JSON string below +json = "{}" +# create an instance of PageJob from a JSON string +page_job_instance = PageJob.from_json(json) +# print the JSON string representation of the object +print PageJob.to_json() + +# convert the object into a dict +page_job_dict = page_job_instance.to_dict() +# create an instance of PageJob from a dict +page_job_form_dict = page_job.from_dict(page_job_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageLanguage.md b/compute_api_client/docs/PageLanguage.md new file mode 100644 index 0000000..62ce7aa --- /dev/null +++ b/compute_api_client/docs/PageLanguage.md @@ -0,0 +1,32 @@ +# PageLanguage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Language]**](Language.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_language import PageLanguage + +# TODO update the JSON string below +json = "{}" +# create an instance of PageLanguage from a JSON string +page_language_instance = PageLanguage.from_json(json) +# print the JSON string representation of the object +print PageLanguage.to_json() + +# convert the object into a dict +page_language_dict = page_language_instance.to_dict() +# create an instance of PageLanguage from a dict +page_language_form_dict = page_language.from_dict(page_language_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageMember.md b/compute_api_client/docs/PageMember.md new file mode 100644 index 0000000..ad51fb4 --- /dev/null +++ b/compute_api_client/docs/PageMember.md @@ -0,0 +1,32 @@ +# PageMember + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Member]**](Member.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_member import PageMember + +# TODO update the JSON string below +json = "{}" +# create an instance of PageMember from a JSON string +page_member_instance = PageMember.from_json(json) +# print the JSON string representation of the object +print PageMember.to_json() + +# convert the object into a dict +page_member_dict = page_member_instance.to_dict() +# create an instance of PageMember from a dict +page_member_form_dict = page_member.from_dict(page_member_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageMetadata.md b/compute_api_client/docs/PageMetadata.md new file mode 100644 index 0000000..ce875bb --- /dev/null +++ b/compute_api_client/docs/PageMetadata.md @@ -0,0 +1,32 @@ +# PageMetadata + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Metadata]**](Metadata.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_metadata import PageMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of PageMetadata from a JSON string +page_metadata_instance = PageMetadata.from_json(json) +# print the JSON string representation of the object +print PageMetadata.to_json() + +# convert the object into a dict +page_metadata_dict = page_metadata_instance.to_dict() +# create an instance of PageMetadata from a dict +page_metadata_form_dict = page_metadata.from_dict(page_metadata_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PagePermission.md b/compute_api_client/docs/PagePermission.md new file mode 100644 index 0000000..b83d78d --- /dev/null +++ b/compute_api_client/docs/PagePermission.md @@ -0,0 +1,32 @@ +# PagePermission + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Permission]**](Permission.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_permission import PagePermission + +# TODO update the JSON string below +json = "{}" +# create an instance of PagePermission from a JSON string +page_permission_instance = PagePermission.from_json(json) +# print the JSON string representation of the object +print PagePermission.to_json() + +# convert the object into a dict +page_permission_dict = page_permission_instance.to_dict() +# create an instance of PagePermission from a dict +page_permission_form_dict = page_permission.from_dict(page_permission_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PagePermissionGroup.md b/compute_api_client/docs/PagePermissionGroup.md new file mode 100644 index 0000000..0f10906 --- /dev/null +++ b/compute_api_client/docs/PagePermissionGroup.md @@ -0,0 +1,32 @@ +# PagePermissionGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[PermissionGroup]**](PermissionGroup.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_permission_group import PagePermissionGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of PagePermissionGroup from a JSON string +page_permission_group_instance = PagePermissionGroup.from_json(json) +# print the JSON string representation of the object +print PagePermissionGroup.to_json() + +# convert the object into a dict +page_permission_group_dict = page_permission_group_instance.to_dict() +# create an instance of PagePermissionGroup from a dict +page_permission_group_form_dict = page_permission_group.from_dict(page_permission_group_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageProject.md b/compute_api_client/docs/PageProject.md new file mode 100644 index 0000000..b61420e --- /dev/null +++ b/compute_api_client/docs/PageProject.md @@ -0,0 +1,32 @@ +# PageProject + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Project]**](Project.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_project import PageProject + +# TODO update the JSON string below +json = "{}" +# create an instance of PageProject from a JSON string +page_project_instance = PageProject.from_json(json) +# print the JSON string representation of the object +print PageProject.to_json() + +# convert the object into a dict +page_project_dict = page_project_instance.to_dict() +# create an instance of PageProject from a dict +page_project_form_dict = page_project.from_dict(page_project_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageReservation.md b/compute_api_client/docs/PageReservation.md new file mode 100644 index 0000000..1416011 --- /dev/null +++ b/compute_api_client/docs/PageReservation.md @@ -0,0 +1,32 @@ +# PageReservation + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Reservation]**](Reservation.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_reservation import PageReservation + +# TODO update the JSON string below +json = "{}" +# create an instance of PageReservation from a JSON string +page_reservation_instance = PageReservation.from_json(json) +# print the JSON string representation of the object +print PageReservation.to_json() + +# convert the object into a dict +page_reservation_dict = page_reservation_instance.to_dict() +# create an instance of PageReservation from a dict +page_reservation_form_dict = page_reservation.from_dict(page_reservation_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageResult.md b/compute_api_client/docs/PageResult.md new file mode 100644 index 0000000..2f82527 --- /dev/null +++ b/compute_api_client/docs/PageResult.md @@ -0,0 +1,32 @@ +# PageResult + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Result]**](Result.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_result import PageResult + +# TODO update the JSON string below +json = "{}" +# create an instance of PageResult from a JSON string +page_result_instance = PageResult.from_json(json) +# print the JSON string representation of the object +print PageResult.to_json() + +# convert the object into a dict +page_result_dict = page_result_instance.to_dict() +# create an instance of PageResult from a dict +page_result_form_dict = page_result.from_dict(page_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageTeam.md b/compute_api_client/docs/PageTeam.md new file mode 100644 index 0000000..d013423 --- /dev/null +++ b/compute_api_client/docs/PageTeam.md @@ -0,0 +1,32 @@ +# PageTeam + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Team]**](Team.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_team import PageTeam + +# TODO update the JSON string below +json = "{}" +# create an instance of PageTeam from a JSON string +page_team_instance = PageTeam.from_json(json) +# print the JSON string representation of the object +print PageTeam.to_json() + +# convert the object into a dict +page_team_dict = page_team_instance.to_dict() +# create an instance of PageTeam from a dict +page_team_form_dict = page_team.from_dict(page_team_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageTransaction.md b/compute_api_client/docs/PageTransaction.md new file mode 100644 index 0000000..507d85d --- /dev/null +++ b/compute_api_client/docs/PageTransaction.md @@ -0,0 +1,32 @@ +# PageTransaction + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[Transaction]**](Transaction.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_transaction import PageTransaction + +# TODO update the JSON string below +json = "{}" +# create an instance of PageTransaction from a JSON string +page_transaction_instance = PageTransaction.from_json(json) +# print the JSON string representation of the object +print PageTransaction.to_json() + +# convert the object into a dict +page_transaction_dict = page_transaction_instance.to_dict() +# create an instance of PageTransaction from a dict +page_transaction_form_dict = page_transaction.from_dict(page_transaction_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PageUser.md b/compute_api_client/docs/PageUser.md new file mode 100644 index 0000000..6c29be7 --- /dev/null +++ b/compute_api_client/docs/PageUser.md @@ -0,0 +1,32 @@ +# PageUser + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[User]**](User.md) | | +**total** | **int** | | +**page** | **int** | | +**size** | **int** | | +**pages** | **int** | | [optional] + +## Example + +```python +from compute_api_client.models.page_user import PageUser + +# TODO update the JSON string below +json = "{}" +# create an instance of PageUser from a JSON string +page_user_instance = PageUser.from_json(json) +# print the JSON string representation of the object +print PageUser.to_json() + +# convert the object into a dict +page_user_dict = page_user_instance.to_dict() +# create an instance of PageUser from a dict +page_user_form_dict = page_user.from_dict(page_user_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/compute_api_client/docs/PermissionsApi.md b/compute_api_client/docs/PermissionsApi.md index 590ea95..d879d2d 100644 --- a/compute_api_client/docs/PermissionsApi.md +++ b/compute_api_client/docs/PermissionsApi.md @@ -87,7 +87,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_permission_groups_permission_groups_get** -> List[PermissionGroup] read_permission_groups_permission_groups_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name) +> PagePermissionGroup read_permission_groups_permission_groups_get(id=id, name=name, sort_by=sort_by, latest=latest, page=page, size=size) List permission groups @@ -100,7 +100,7 @@ Read permissions groups. import time import os import compute_api_client -from compute_api_client.models.permission_group import PermissionGroup +from compute_api_client.models.page_permission_group import PagePermissionGroup from compute_api_client.rest import ApiException from pprint import pprint @@ -121,16 +121,16 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.PermissionsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) name = 'name_example' # str | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List permission groups - api_response = await api_instance.read_permission_groups_permission_groups_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name) + api_response = await api_instance.read_permission_groups_permission_groups_get(id=id, name=name, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of PermissionsApi->read_permission_groups_permission_groups_get:\n") pprint(api_response) except Exception as e: @@ -143,16 +143,16 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **name** | **str**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[PermissionGroup]**](PermissionGroup.md) +[**PagePermissionGroup**](PagePermissionGroup.md) ### Authorization @@ -248,7 +248,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_permissions_permissions_get** -> List[Permission] read_permissions_permissions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, permission=permission, name=name) +> PagePermission read_permissions_permissions_get(id=id, permission=permission, name=name, sort_by=sort_by, latest=latest, page=page, size=size) List permissions @@ -261,7 +261,7 @@ Read permissions. import time import os import compute_api_client -from compute_api_client.models.permission import Permission +from compute_api_client.models.page_permission import PagePermission from compute_api_client.rest import ApiException from pprint import pprint @@ -282,17 +282,17 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.PermissionsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) permission = 'permission_example' # str | (optional) name = 'name_example' # str | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List permissions - api_response = await api_instance.read_permissions_permissions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, permission=permission, name=name) + api_response = await api_instance.read_permissions_permissions_get(id=id, permission=permission, name=name, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of PermissionsApi->read_permissions_permissions_get:\n") pprint(api_response) except Exception as e: @@ -305,17 +305,17 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **permission** | **str**| | [optional] **name** | **str**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Permission]**](Permission.md) +[**PagePermission**](PagePermission.md) ### Authorization diff --git a/compute_api_client/docs/ProjectsApi.md b/compute_api_client/docs/ProjectsApi.md index d9bfe42..f38e391 100644 --- a/compute_api_client/docs/ProjectsApi.md +++ b/compute_api_client/docs/ProjectsApi.md @@ -317,7 +317,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_projects_projects_get** -> List[Project] read_projects_projects_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred) +> PageProject read_projects_projects_get(search=search, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred, sort_by=sort_by, latest=latest, page=page, size=size) List projects @@ -330,7 +330,7 @@ List projects. If the search parameter is provided, the list is filtered based import time import os import compute_api_client -from compute_api_client.models.project import Project +from compute_api_client.models.page_project import PageProject from compute_api_client.rest import ApiException from pprint import pprint @@ -352,20 +352,20 @@ async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.ProjectsApi(api_client) search = 'search_example' # str | Substring search for project names or description (optional) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional) owner_id = 56 # int | (optional) name = 'name_example' # str | (optional) description = 'description_example' # str | (optional) starred = True # bool | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List projects - api_response = await api_instance.read_projects_projects_get(search=search, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred) + api_response = await api_instance.read_projects_projects_get(search=search, id=id, created_on=created_on, owner_id=owner_id, name=name, description=description, starred=starred, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of ProjectsApi->read_projects_projects_get:\n") pprint(api_response) except Exception as e: @@ -379,20 +379,20 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **search** | **str**| Substring search for project names or description | [optional] - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **created_on** | **datetime**| | [optional] **owner_id** | **int**| | [optional] **name** | **str**| | [optional] **description** | **str**| | [optional] **starred** | **bool**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Project]**](Project.md) +[**PageProject**](PageProject.md) ### Authorization diff --git a/compute_api_client/docs/ReservationsApi.md b/compute_api_client/docs/ReservationsApi.md index a4a5629..d7ea9a5 100644 --- a/compute_api_client/docs/ReservationsApi.md +++ b/compute_api_client/docs/ReservationsApi.md @@ -163,7 +163,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_reservations_reservations_get** -> List[Reservation] read_reservations_reservations_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated) +> PageReservation read_reservations_reservations_get(id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated, sort_by=sort_by, latest=latest, page=page, size=size) List reservations @@ -176,7 +176,7 @@ Read reservations. import time import os import compute_api_client -from compute_api_client.models.reservation import Reservation +from compute_api_client.models.page_reservation import PageReservation from compute_api_client.rest import ApiException from pprint import pprint @@ -197,10 +197,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.ReservationsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) member_id = 56 # int | (optional) start_time = '2013-10-20T19:20:30+01:00' # datetime | (optional) @@ -209,10 +205,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: backend_id__isnull = True # bool | (optional) backend_id = 56 # int | (optional) is_terminated = True # bool | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List reservations - api_response = await api_instance.read_reservations_reservations_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated) + api_response = await api_instance.read_reservations_reservations_get(id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of ReservationsApi->read_reservations_reservations_get:\n") pprint(api_response) except Exception as e: @@ -225,10 +225,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **member_id** | **int**| | [optional] **start_time** | **datetime**| | [optional] @@ -237,10 +233,14 @@ Name | Type | Description | Notes **backend_id__isnull** | **bool**| | [optional] **backend_id** | **int**| | [optional] **is_terminated** | **bool**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Reservation]**](Reservation.md) +[**PageReservation**](PageReservation.md) ### Authorization diff --git a/compute_api_client/docs/ResultsApi.md b/compute_api_client/docs/ResultsApi.md index 4c87f8f..38ae3dc 100644 --- a/compute_api_client/docs/ResultsApi.md +++ b/compute_api_client/docs/ResultsApi.md @@ -245,7 +245,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_results_by_algorithm_id_results_algorithm_algorithm_id_get** -> List[Result] read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, body=body) +> PageResult read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, sort_by=sort_by, latest=latest, page=page, size=size, body=body) Retrieve results by algorithm ID @@ -258,7 +258,7 @@ Get results by algorithm ID. import time import os import compute_api_client -from compute_api_client.models.result import Result +from compute_api_client.models.page_result import PageResult from compute_api_client.rest import ApiException from pprint import pprint @@ -280,10 +280,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.ResultsApi(api_client) algorithm_id = 56 # int | - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional) job_id = 56 # int | (optional) @@ -294,11 +290,15 @@ async with compute_api_client.ApiClient(configuration) as api_client: shots_done__isnull = True # bool | (optional) shots_done = 56 # int | (optional) results__isnull = True # bool | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) body = None # object | (optional) try: # Retrieve results by algorithm ID - api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, body=body) + api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, sort_by=sort_by, latest=latest, page=page, size=size, body=body) print("The response of ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get:\n") pprint(api_response) except Exception as e: @@ -312,10 +312,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **algorithm_id** | **int**| | - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **created_on** | **datetime**| | [optional] **job_id** | **int**| | [optional] @@ -326,11 +322,15 @@ Name | Type | Description | Notes **shots_done__isnull** | **bool**| | [optional] **shots_done** | **int**| | [optional] **results__isnull** | **bool**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] **body** | **object**| | [optional] ### Return type -[**List[Result]**](Result.md) +[**PageResult**](PageResult.md) ### Authorization @@ -351,7 +351,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_results_by_job_id_results_job_job_id_get** -> List[Result] read_results_by_job_id_results_job_job_id_get(job_id) +> PageResult read_results_by_job_id_results_job_job_id_get(job_id, page=page, size=size, sort_by=sort_by, latest=latest) Retrieve results by job ID @@ -364,7 +364,7 @@ Get results by job ID. import time import os import compute_api_client -from compute_api_client.models.result import Result +from compute_api_client.models.page_result import PageResult from compute_api_client.rest import ApiException from pprint import pprint @@ -386,10 +386,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.ResultsApi(api_client) job_id = 56 # int | + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) + sort_by = 'sort_by_example' # str | (optional) + latest = True # bool | (optional) try: # Retrieve results by job ID - api_response = await api_instance.read_results_by_job_id_results_job_job_id_get(job_id) + api_response = await api_instance.read_results_by_job_id_results_job_job_id_get(job_id, page=page, size=size, sort_by=sort_by, latest=latest) print("The response of ResultsApi->read_results_by_job_id_results_job_job_id_get:\n") pprint(api_response) except Exception as e: @@ -403,10 +407,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **job_id** | **int**| | + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] + **sort_by** | **str**| | [optional] + **latest** | **bool**| | [optional] ### Return type -[**List[Result]**](Result.md) +[**PageResult**](PageResult.md) ### Authorization diff --git a/compute_api_client/docs/TeamsApi.md b/compute_api_client/docs/TeamsApi.md index 5ce35e4..7b71b53 100644 --- a/compute_api_client/docs/TeamsApi.md +++ b/compute_api_client/docs/TeamsApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_teams_teams_get** -> List[Team] read_teams_teams_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, slug=slug, individual_user=individual_user) +> PageTeam read_teams_teams_get(id=id, name=name, slug=slug, individual_user=individual_user, sort_by=sort_by, latest=latest, page=page, size=size) List teams @@ -98,7 +98,7 @@ Read teams. import time import os import compute_api_client -from compute_api_client.models.team import Team +from compute_api_client.models.page_team import PageTeam from compute_api_client.rest import ApiException from pprint import pprint @@ -119,18 +119,18 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.TeamsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) name = 'name_example' # str | (optional) slug = 'slug_example' # str | (optional) individual_user = True # bool | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List teams - api_response = await api_instance.read_teams_teams_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, slug=slug, individual_user=individual_user) + api_response = await api_instance.read_teams_teams_get(id=id, name=name, slug=slug, individual_user=individual_user, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of TeamsApi->read_teams_teams_get:\n") pprint(api_response) except Exception as e: @@ -143,18 +143,18 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **name** | **str**| | [optional] **slug** | **str**| | [optional] **individual_user** | **bool**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Team]**](Team.md) +[**PageTeam**](PageTeam.md) ### Authorization diff --git a/compute_api_client/docs/TransactionsApi.md b/compute_api_client/docs/TransactionsApi.md index 1534359..79ca185 100644 --- a/compute_api_client/docs/TransactionsApi.md +++ b/compute_api_client/docs/TransactionsApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_transactions_transactions_get** -> List[Transaction] read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp) +> PageTransaction read_transactions_transactions_get(id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp, sort_by=sort_by, latest=latest, page=page, size=size) List transactions @@ -99,7 +99,7 @@ import time import os import compute_api_client from compute_api_client.models.domain import Domain -from compute_api_client.models.transaction import Transaction +from compute_api_client.models.page_transaction import PageTransaction from compute_api_client.rest import ApiException from pprint import pprint @@ -120,10 +120,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.TransactionsApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) domain__isnull = True # bool | (optional) domain = compute_api_client.Domain() # Domain | (optional) @@ -134,10 +130,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: member_id = 56 # int | (optional) change = 56 # int | (optional) timestamp = '2013-10-20T19:20:30+01:00' # datetime | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List transactions - api_response = await api_instance.read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp) + api_response = await api_instance.read_transactions_transactions_get(id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of TransactionsApi->read_transactions_transactions_get:\n") pprint(api_response) except Exception as e: @@ -150,10 +150,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **domain__isnull** | **bool**| | [optional] **domain** | [**Domain**](.md)| | [optional] @@ -164,10 +160,14 @@ Name | Type | Description | Notes **member_id** | **int**| | [optional] **change** | **int**| | [optional] **timestamp** | **datetime**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[Transaction]**](Transaction.md) +[**PageTransaction**](PageTransaction.md) ### Authorization diff --git a/compute_api_client/docs/UsersApi.md b/compute_api_client/docs/UsersApi.md index a3cb264..954529f 100644 --- a/compute_api_client/docs/UsersApi.md +++ b/compute_api_client/docs/UsersApi.md @@ -236,7 +236,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **read_users_users_get** -> List[User] read_users_users_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub) +> PageUser read_users_users_get(id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, sort_by=sort_by, latest=latest, page=page, size=size) List users @@ -249,7 +249,7 @@ Read users. import time import os import compute_api_client -from compute_api_client.models.user import User +from compute_api_client.models.page_user import PageUser from compute_api_client.rest import ApiException from pprint import pprint @@ -270,10 +270,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] async with compute_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = compute_api_client.UsersApi(api_client) - latest = True # bool | (optional) - sort_by = 'sort_by_example' # str | (optional) - page_number = 56 # int | (optional) - items_per_page = 56 # int | (optional) id = 56 # int | (optional) full_name = 'full_name_example' # str | (optional) email = 'email_example' # str | (optional) @@ -282,10 +278,14 @@ async with compute_api_client.ApiClient(configuration) as api_client: is_active = True # bool | (optional) is_confirmed = True # bool | (optional) oidc_sub = 'oidc_sub_example' # str | (optional) + sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional) + latest = True # bool | If True gets the most recently created object. (optional) + page = 1 # int | Page number (optional) (default to 1) + size = 50 # int | Page size (optional) (default to 50) try: # List users - api_response = await api_instance.read_users_users_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub) + api_response = await api_instance.read_users_users_get(id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, sort_by=sort_by, latest=latest, page=page, size=size) print("The response of UsersApi->read_users_users_get:\n") pprint(api_response) except Exception as e: @@ -298,10 +298,6 @@ async with compute_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **latest** | **bool**| | [optional] - **sort_by** | **str**| | [optional] - **page_number** | **int**| | [optional] - **items_per_page** | **int**| | [optional] **id** | **int**| | [optional] **full_name** | **str**| | [optional] **email** | **str**| | [optional] @@ -310,10 +306,14 @@ Name | Type | Description | Notes **is_active** | **bool**| | [optional] **is_confirmed** | **bool**| | [optional] **oidc_sub** | **str**| | [optional] + **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] + **latest** | **bool**| If True gets the most recently created object. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **size** | **int**| Page size | [optional] [default to 50] ### Return type -[**List[User]**](User.md) +[**PageUser**](PageUser.md) ### Authorization diff --git a/compute_api_client/exceptions.py b/compute_api_client/exceptions.py index c08c607..076f7c9 100644 --- a/compute_api_client/exceptions.py +++ b/compute_api_client/exceptions.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/__init__.py b/compute_api_client/models/__init__.py index 6439a64..43f5c72 100644 --- a/compute_api_client/models/__init__.py +++ b/compute_api_client/models/__init__.py @@ -4,7 +4,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -46,6 +46,24 @@ from compute_api_client.models.member_in import MemberIn from compute_api_client.models.metadata import Metadata from compute_api_client.models.metadata_in import MetadataIn +from compute_api_client.models.page_algorithm import PageAlgorithm +from compute_api_client.models.page_backend import PageBackend +from compute_api_client.models.page_backend_type import PageBackendType +from compute_api_client.models.page_batch_job import PageBatchJob +from compute_api_client.models.page_commit import PageCommit +from compute_api_client.models.page_file import PageFile +from compute_api_client.models.page_job import PageJob +from compute_api_client.models.page_language import PageLanguage +from compute_api_client.models.page_member import PageMember +from compute_api_client.models.page_metadata import PageMetadata +from compute_api_client.models.page_permission import PagePermission +from compute_api_client.models.page_permission_group import PagePermissionGroup +from compute_api_client.models.page_project import PageProject +from compute_api_client.models.page_reservation import PageReservation +from compute_api_client.models.page_result import PageResult +from compute_api_client.models.page_team import PageTeam +from compute_api_client.models.page_transaction import PageTransaction +from compute_api_client.models.page_user import PageUser from compute_api_client.models.permission import Permission from compute_api_client.models.permission_group import PermissionGroup from compute_api_client.models.project import Project diff --git a/compute_api_client/models/algorithm.py b/compute_api_client/models/algorithm.py index 4d9df75..8582466 100644 --- a/compute_api_client/models/algorithm.py +++ b/compute_api_client/models/algorithm.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/algorithm_in.py b/compute_api_client/models/algorithm_in.py index 9df91da..7904d74 100644 --- a/compute_api_client/models/algorithm_in.py +++ b/compute_api_client/models/algorithm_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/algorithm_type.py b/compute_api_client/models/algorithm_type.py index d002fd0..14a1ee9 100644 --- a/compute_api_client/models/algorithm_type.py +++ b/compute_api_client/models/algorithm_type.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/backend.py b/compute_api_client/models/backend.py index 6105ef6..ec347e2 100644 --- a/compute_api_client/models/backend.py +++ b/compute_api_client/models/backend.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/backend_in.py b/compute_api_client/models/backend_in.py index e1d8173..fc83adb 100644 --- a/compute_api_client/models/backend_in.py +++ b/compute_api_client/models/backend_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/backend_patch.py b/compute_api_client/models/backend_patch.py index 077d141..9d96a42 100644 --- a/compute_api_client/models/backend_patch.py +++ b/compute_api_client/models/backend_patch.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/backend_status.py b/compute_api_client/models/backend_status.py index 7f536cc..e7a993b 100644 --- a/compute_api_client/models/backend_status.py +++ b/compute_api_client/models/backend_status.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/backend_type.py b/compute_api_client/models/backend_type.py index ae765e9..e054d91 100644 --- a/compute_api_client/models/backend_type.py +++ b/compute_api_client/models/backend_type.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/backend_with_authentication.py b/compute_api_client/models/backend_with_authentication.py index afb25aa..276f89f 100644 --- a/compute_api_client/models/backend_with_authentication.py +++ b/compute_api_client/models/backend_with_authentication.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/batch_job.py b/compute_api_client/models/batch_job.py index 965f472..d718b61 100644 --- a/compute_api_client/models/batch_job.py +++ b/compute_api_client/models/batch_job.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/batch_job_in.py b/compute_api_client/models/batch_job_in.py index b730a35..daffab1 100644 --- a/compute_api_client/models/batch_job_in.py +++ b/compute_api_client/models/batch_job_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/batch_job_status.py b/compute_api_client/models/batch_job_status.py index e402dd2..23a5ca0 100644 --- a/compute_api_client/models/batch_job_status.py +++ b/compute_api_client/models/batch_job_status.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/commit.py b/compute_api_client/models/commit.py index 75167a6..3164a08 100644 --- a/compute_api_client/models/commit.py +++ b/compute_api_client/models/commit.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/commit_in.py b/compute_api_client/models/commit_in.py index ef62e46..73453f9 100644 --- a/compute_api_client/models/commit_in.py +++ b/compute_api_client/models/commit_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/compile_stage.py b/compute_api_client/models/compile_stage.py index 42708e9..ae030b6 100644 --- a/compute_api_client/models/compile_stage.py +++ b/compute_api_client/models/compile_stage.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/domain.py b/compute_api_client/models/domain.py index 34eb366..181eb01 100644 --- a/compute_api_client/models/domain.py +++ b/compute_api_client/models/domain.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/file.py b/compute_api_client/models/file.py index 84de6ab..e4e931f 100644 --- a/compute_api_client/models/file.py +++ b/compute_api_client/models/file.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/file_in.py b/compute_api_client/models/file_in.py index df5edeb..cc10b6d 100644 --- a/compute_api_client/models/file_in.py +++ b/compute_api_client/models/file_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/final_result.py b/compute_api_client/models/final_result.py index 876c195..180018e 100644 --- a/compute_api_client/models/final_result.py +++ b/compute_api_client/models/final_result.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/final_result_in.py b/compute_api_client/models/final_result_in.py index 601b5ce..20e574b 100644 --- a/compute_api_client/models/final_result_in.py +++ b/compute_api_client/models/final_result_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/http_not_found_error.py b/compute_api_client/models/http_not_found_error.py index 9b830ee..14e2234 100644 --- a/compute_api_client/models/http_not_found_error.py +++ b/compute_api_client/models/http_not_found_error.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/http_validation_error.py b/compute_api_client/models/http_validation_error.py index c4b26ff..99f138b 100644 --- a/compute_api_client/models/http_validation_error.py +++ b/compute_api_client/models/http_validation_error.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/job.py b/compute_api_client/models/job.py index 5ac2495..6646948 100644 --- a/compute_api_client/models/job.py +++ b/compute_api_client/models/job.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/job_in.py b/compute_api_client/models/job_in.py index fd00c9f..561c99d 100644 --- a/compute_api_client/models/job_in.py +++ b/compute_api_client/models/job_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/job_patch.py b/compute_api_client/models/job_patch.py index 5d9cce5..0281e65 100644 --- a/compute_api_client/models/job_patch.py +++ b/compute_api_client/models/job_patch.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/job_status.py b/compute_api_client/models/job_status.py index 7acc32b..7d726e3 100644 --- a/compute_api_client/models/job_status.py +++ b/compute_api_client/models/job_status.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/language.py b/compute_api_client/models/language.py index 569a5b2..8ec417e 100644 --- a/compute_api_client/models/language.py +++ b/compute_api_client/models/language.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/location_inner.py b/compute_api_client/models/location_inner.py index 509e923..9630daa 100644 --- a/compute_api_client/models/location_inner.py +++ b/compute_api_client/models/location_inner.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/member.py b/compute_api_client/models/member.py index f57b943..85a679c 100644 --- a/compute_api_client/models/member.py +++ b/compute_api_client/models/member.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/member_in.py b/compute_api_client/models/member_in.py index a08d35f..39bc9ac 100644 --- a/compute_api_client/models/member_in.py +++ b/compute_api_client/models/member_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/metadata.py b/compute_api_client/models/metadata.py index cc7b6aa..18801cf 100644 --- a/compute_api_client/models/metadata.py +++ b/compute_api_client/models/metadata.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/metadata_in.py b/compute_api_client/models/metadata_in.py index 6b31413..8668b3c 100644 --- a/compute_api_client/models/metadata_in.py +++ b/compute_api_client/models/metadata_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/page_algorithm.py b/compute_api_client/models/page_algorithm.py new file mode 100644 index 0000000..7ef8d40 --- /dev/null +++ b/compute_api_client/models/page_algorithm.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.algorithm import Algorithm +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageAlgorithm(BaseModel): + """ + PageAlgorithm + """ # noqa: E501 + items: List[Algorithm] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageAlgorithm from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageAlgorithm from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Algorithm.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_backend.py b/compute_api_client/models/page_backend.py new file mode 100644 index 0000000..d65b6db --- /dev/null +++ b/compute_api_client/models/page_backend.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.backend import Backend +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageBackend(BaseModel): + """ + PageBackend + """ # noqa: E501 + items: List[Backend] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageBackend from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageBackend from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Backend.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_backend_type.py b/compute_api_client/models/page_backend_type.py new file mode 100644 index 0000000..4d1b56d --- /dev/null +++ b/compute_api_client/models/page_backend_type.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.backend_type import BackendType +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageBackendType(BaseModel): + """ + PageBackendType + """ # noqa: E501 + items: List[BackendType] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageBackendType from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageBackendType from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [BackendType.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_batch_job.py b/compute_api_client/models/page_batch_job.py new file mode 100644 index 0000000..9df84f2 --- /dev/null +++ b/compute_api_client/models/page_batch_job.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.batch_job import BatchJob +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageBatchJob(BaseModel): + """ + PageBatchJob + """ # noqa: E501 + items: List[BatchJob] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageBatchJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageBatchJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [BatchJob.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_commit.py b/compute_api_client/models/page_commit.py new file mode 100644 index 0000000..7ccf1b0 --- /dev/null +++ b/compute_api_client/models/page_commit.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.commit import Commit +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageCommit(BaseModel): + """ + PageCommit + """ # noqa: E501 + items: List[Commit] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageCommit from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageCommit from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Commit.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_file.py b/compute_api_client/models/page_file.py new file mode 100644 index 0000000..d6ef6d4 --- /dev/null +++ b/compute_api_client/models/page_file.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.file import File +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageFile(BaseModel): + """ + PageFile + """ # noqa: E501 + items: List[File] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageFile from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageFile from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [File.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_job.py b/compute_api_client/models/page_job.py new file mode 100644 index 0000000..6253ead --- /dev/null +++ b/compute_api_client/models/page_job.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.job import Job +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageJob(BaseModel): + """ + PageJob + """ # noqa: E501 + items: List[Job] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Job.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_language.py b/compute_api_client/models/page_language.py new file mode 100644 index 0000000..21e2d66 --- /dev/null +++ b/compute_api_client/models/page_language.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.language import Language +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageLanguage(BaseModel): + """ + PageLanguage + """ # noqa: E501 + items: List[Language] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageLanguage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageLanguage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Language.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_member.py b/compute_api_client/models/page_member.py new file mode 100644 index 0000000..8de5675 --- /dev/null +++ b/compute_api_client/models/page_member.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.member import Member +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageMember(BaseModel): + """ + PageMember + """ # noqa: E501 + items: List[Member] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageMember from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageMember from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Member.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_metadata.py b/compute_api_client/models/page_metadata.py new file mode 100644 index 0000000..6c7d917 --- /dev/null +++ b/compute_api_client/models/page_metadata.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.metadata import Metadata +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageMetadata(BaseModel): + """ + PageMetadata + """ # noqa: E501 + items: List[Metadata] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Metadata.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_permission.py b/compute_api_client/models/page_permission.py new file mode 100644 index 0000000..fd2804f --- /dev/null +++ b/compute_api_client/models/page_permission.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.permission import Permission +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PagePermission(BaseModel): + """ + PagePermission + """ # noqa: E501 + items: List[Permission] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PagePermission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PagePermission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Permission.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_permission_group.py b/compute_api_client/models/page_permission_group.py new file mode 100644 index 0000000..c83bffa --- /dev/null +++ b/compute_api_client/models/page_permission_group.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.permission_group import PermissionGroup +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PagePermissionGroup(BaseModel): + """ + PagePermissionGroup + """ # noqa: E501 + items: List[PermissionGroup] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PagePermissionGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PagePermissionGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [PermissionGroup.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_project.py b/compute_api_client/models/page_project.py new file mode 100644 index 0000000..cef9412 --- /dev/null +++ b/compute_api_client/models/page_project.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.project import Project +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageProject(BaseModel): + """ + PageProject + """ # noqa: E501 + items: List[Project] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageProject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageProject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Project.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_reservation.py b/compute_api_client/models/page_reservation.py new file mode 100644 index 0000000..51dbc89 --- /dev/null +++ b/compute_api_client/models/page_reservation.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.reservation import Reservation +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageReservation(BaseModel): + """ + PageReservation + """ # noqa: E501 + items: List[Reservation] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageReservation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageReservation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Reservation.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_result.py b/compute_api_client/models/page_result.py new file mode 100644 index 0000000..25beced --- /dev/null +++ b/compute_api_client/models/page_result.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.result import Result +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageResult(BaseModel): + """ + PageResult + """ # noqa: E501 + items: List[Result] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Result.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_team.py b/compute_api_client/models/page_team.py new file mode 100644 index 0000000..ad10b11 --- /dev/null +++ b/compute_api_client/models/page_team.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.team import Team +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageTeam(BaseModel): + """ + PageTeam + """ # noqa: E501 + items: List[Team] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageTeam from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageTeam from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Team.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_transaction.py b/compute_api_client/models/page_transaction.py new file mode 100644 index 0000000..8e8f996 --- /dev/null +++ b/compute_api_client/models/page_transaction.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.transaction import Transaction +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageTransaction(BaseModel): + """ + PageTransaction + """ # noqa: E501 + items: List[Transaction] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageTransaction from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageTransaction from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [Transaction.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/page_user.py b/compute_api_client/models/page_user.py new file mode 100644 index 0000000..c12173f --- /dev/null +++ b/compute_api_client/models/page_user.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from compute_api_client.models.user import User +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class PageUser(BaseModel): + """ + PageUser + """ # noqa: E501 + items: List[User] + total: Optional[Annotated[int, Field(strict=True, ge=0)]] + page: Optional[Annotated[int, Field(strict=True, ge=1)]] + size: Optional[Annotated[int, Field(strict=True, ge=1)]] + pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None + __properties: ClassVar[List[str]] = ["items", "total", "page", "size", "pages"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PageUser from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict['items'] = _items + # set to None if total (nullable) is None + # and model_fields_set contains the field + if self.total is None and "total" in self.model_fields_set: + _dict['total'] = None + + # set to None if page (nullable) is None + # and model_fields_set contains the field + if self.page is None and "page" in self.model_fields_set: + _dict['page'] = None + + # set to None if size (nullable) is None + # and model_fields_set contains the field + if self.size is None and "size" in self.model_fields_set: + _dict['size'] = None + + # set to None if pages (nullable) is None + # and model_fields_set contains the field + if self.pages is None and "pages" in self.model_fields_set: + _dict['pages'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of PageUser from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [User.from_dict(_item) for _item in obj.get("items")] if obj.get("items") is not None else None, + "total": obj.get("total"), + "page": obj.get("page"), + "size": obj.get("size"), + "pages": obj.get("pages") + }) + return _obj + + diff --git a/compute_api_client/models/permission.py b/compute_api_client/models/permission.py index f2cf2d7..3209f36 100644 --- a/compute_api_client/models/permission.py +++ b/compute_api_client/models/permission.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/permission_group.py b/compute_api_client/models/permission_group.py index 7b7854d..af271eb 100644 --- a/compute_api_client/models/permission_group.py +++ b/compute_api_client/models/permission_group.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/project.py b/compute_api_client/models/project.py index 7f40f46..b7041f7 100644 --- a/compute_api_client/models/project.py +++ b/compute_api_client/models/project.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/project_in.py b/compute_api_client/models/project_in.py index ecdfd9d..445699c 100644 --- a/compute_api_client/models/project_in.py +++ b/compute_api_client/models/project_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/project_patch.py b/compute_api_client/models/project_patch.py index d5e6daa..f9f1318 100644 --- a/compute_api_client/models/project_patch.py +++ b/compute_api_client/models/project_patch.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/reservation.py b/compute_api_client/models/reservation.py index 5d993a2..90f328f 100644 --- a/compute_api_client/models/reservation.py +++ b/compute_api_client/models/reservation.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/reservation_in.py b/compute_api_client/models/reservation_in.py index 7c27568..cfdba72 100644 --- a/compute_api_client/models/reservation_in.py +++ b/compute_api_client/models/reservation_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/result.py b/compute_api_client/models/result.py index 7a01aa5..e16ba96 100644 --- a/compute_api_client/models/result.py +++ b/compute_api_client/models/result.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/result_in.py b/compute_api_client/models/result_in.py index f8f0680..7daff51 100644 --- a/compute_api_client/models/result_in.py +++ b/compute_api_client/models/result_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/role.py b/compute_api_client/models/role.py index 8b07999..843d88b 100644 --- a/compute_api_client/models/role.py +++ b/compute_api_client/models/role.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/share_type.py b/compute_api_client/models/share_type.py index a03311b..28cd988 100644 --- a/compute_api_client/models/share_type.py +++ b/compute_api_client/models/share_type.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/team.py b/compute_api_client/models/team.py index e377cef..7eebb61 100644 --- a/compute_api_client/models/team.py +++ b/compute_api_client/models/team.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/transaction.py b/compute_api_client/models/transaction.py index 6b62a4f..d23afcf 100644 --- a/compute_api_client/models/transaction.py +++ b/compute_api_client/models/transaction.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/user.py b/compute_api_client/models/user.py index 57c020d..7447347 100644 --- a/compute_api_client/models/user.py +++ b/compute_api_client/models/user.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/user_in.py b/compute_api_client/models/user_in.py index f50df4e..358116c 100644 --- a/compute_api_client/models/user_in.py +++ b/compute_api_client/models/user_in.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/models/validation_error.py b/compute_api_client/models/validation_error.py index c454f48..1586911 100644 --- a/compute_api_client/models/validation_error.py +++ b/compute_api_client/models/validation_error.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/rest.py b/compute_api_client/rest.py index d6148c8..ecbbd76 100644 --- a/compute_api_client/rest.py +++ b/compute_api_client/rest.py @@ -3,7 +3,7 @@ """ Quantum Inspire 2 - **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. + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/compute_api_client/test/test_page_algorithm.py b/compute_api_client/test/test_page_algorithm.py new file mode 100644 index 0000000..97e2f20 --- /dev/null +++ b/compute_api_client/test/test_page_algorithm.py @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_algorithm import PageAlgorithm + +class TestPageAlgorithm(unittest.TestCase): + """PageAlgorithm unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageAlgorithm: + """Test PageAlgorithm + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageAlgorithm` + """ + model = PageAlgorithm() + if include_optional: + return PageAlgorithm( + items = [ + compute_api_client.models.algorithm.Algorithm( + id = 56, + project_id = 56, + type = 'hybrid', + shared = 'private', + link = '', + name = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageAlgorithm( + items = [ + compute_api_client.models.algorithm.Algorithm( + id = 56, + project_id = 56, + type = 'hybrid', + shared = 'private', + link = '', + name = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageAlgorithm(self): + """Test PageAlgorithm""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_backend.py b/compute_api_client/test/test_page_backend.py new file mode 100644 index 0000000..47ec8f0 --- /dev/null +++ b/compute_api_client/test/test_page_backend.py @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_backend import PageBackend + +class TestPageBackend(unittest.TestCase): + """PageBackend unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageBackend: + """Test PageBackend + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageBackend` + """ + model = PageBackend() + if include_optional: + return PageBackend( + items = [ + compute_api_client.models.backend.Backend( + id = 56, + name = '', + location = '', + backend_type_id = 56, + status = 'offline', + last_heartbeat = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageBackend( + items = [ + compute_api_client.models.backend.Backend( + id = 56, + name = '', + location = '', + backend_type_id = 56, + status = 'offline', + last_heartbeat = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageBackend(self): + """Test PageBackend""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_backend_type.py b/compute_api_client/test/test_page_backend_type.py new file mode 100644 index 0000000..5cc29b7 --- /dev/null +++ b/compute_api_client/test/test_page_backend_type.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_backend_type import PageBackendType + +class TestPageBackendType(unittest.TestCase): + """PageBackendType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageBackendType: + """Test PageBackendType + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageBackendType` + """ + model = PageBackendType() + if include_optional: + return PageBackendType( + items = [ + compute_api_client.models.backend_type.BackendType( + id = 56, + name = '', + infrastructure = '', + description = '', + image_id = '', + is_hardware = True, + features = [ + '' + ], + default_compiler_config = compute_api_client.models.default_compiler_config.Default Compiler Config(), + native_gateset = compute_api_client.models.native_gateset.Native Gateset(), + status = 'offline', + default_number_of_shots = 56, + max_number_of_shots = 56, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageBackendType( + items = [ + compute_api_client.models.backend_type.BackendType( + id = 56, + name = '', + infrastructure = '', + description = '', + image_id = '', + is_hardware = True, + features = [ + '' + ], + default_compiler_config = compute_api_client.models.default_compiler_config.Default Compiler Config(), + native_gateset = compute_api_client.models.native_gateset.Native Gateset(), + status = 'offline', + default_number_of_shots = 56, + max_number_of_shots = 56, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageBackendType(self): + """Test PageBackendType""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_batch_job.py b/compute_api_client/test/test_page_batch_job.py new file mode 100644 index 0000000..0fb1df1 --- /dev/null +++ b/compute_api_client/test/test_page_batch_job.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_batch_job import PageBatchJob + +class TestPageBatchJob(unittest.TestCase): + """PageBatchJob unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageBatchJob: + """Test PageBatchJob + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageBatchJob` + """ + model = PageBatchJob() + if include_optional: + return PageBatchJob( + items = [ + compute_api_client.models.batch_job.BatchJob( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + status = 'planned', + user_id = 56, + backend_type_id = 56, + backend_id = 56, + queued_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + reserved_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + finished_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + job_ids = [ + 56 + ], + aggregated_algorithm_type = 'hybrid', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageBatchJob( + items = [ + compute_api_client.models.batch_job.BatchJob( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + status = 'planned', + user_id = 56, + backend_type_id = 56, + backend_id = 56, + queued_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + reserved_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + finished_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + job_ids = [ + 56 + ], + aggregated_algorithm_type = 'hybrid', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageBatchJob(self): + """Test PageBatchJob""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_commit.py b/compute_api_client/test/test_page_commit.py new file mode 100644 index 0000000..655c3dc --- /dev/null +++ b/compute_api_client/test/test_page_commit.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_commit import PageCommit + +class TestPageCommit(unittest.TestCase): + """PageCommit unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageCommit: + """Test PageCommit + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageCommit` + """ + model = PageCommit() + if include_optional: + return PageCommit( + items = [ + compute_api_client.models.commit.Commit( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + hash = '', + description = '', + algorithm_id = 56, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageCommit( + items = [ + compute_api_client.models.commit.Commit( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + hash = '', + description = '', + algorithm_id = 56, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageCommit(self): + """Test PageCommit""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_file.py b/compute_api_client/test/test_page_file.py new file mode 100644 index 0000000..489e140 --- /dev/null +++ b/compute_api_client/test/test_page_file.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_file import PageFile + +class TestPageFile(unittest.TestCase): + """PageFile unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageFile: + """Test PageFile + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageFile` + """ + model = PageFile() + if include_optional: + return PageFile( + items = [ + compute_api_client.models.file.File( + id = 56, + commit_id = 56, + content = '', + language_id = 56, + compile_stage = 'none', + compile_properties = compute_api_client.models.compile_properties.Compile Properties(), + generated = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageFile( + items = [ + compute_api_client.models.file.File( + id = 56, + commit_id = 56, + content = '', + language_id = 56, + compile_stage = 'none', + compile_properties = compute_api_client.models.compile_properties.Compile Properties(), + generated = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageFile(self): + """Test PageFile""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_job.py b/compute_api_client/test/test_page_job.py new file mode 100644 index 0000000..970439d --- /dev/null +++ b/compute_api_client/test/test_page_job.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_job import PageJob + +class TestPageJob(unittest.TestCase): + """PageJob unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageJob: + """Test PageJob + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageJob` + """ + model = PageJob() + if include_optional: + return PageJob( + items = [ + compute_api_client.models.job.Job( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + file_id = 56, + algorithm_type = 'hybrid', + status = 'planned', + batch_job_id = 56, + queued_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + finished_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + number_of_shots = 56, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageJob( + items = [ + compute_api_client.models.job.Job( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + file_id = 56, + algorithm_type = 'hybrid', + status = 'planned', + batch_job_id = 56, + queued_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + finished_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + number_of_shots = 56, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageJob(self): + """Test PageJob""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_language.py b/compute_api_client/test/test_page_language.py new file mode 100644 index 0000000..f763f80 --- /dev/null +++ b/compute_api_client/test/test_page_language.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_language import PageLanguage + +class TestPageLanguage(unittest.TestCase): + """PageLanguage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageLanguage: + """Test PageLanguage + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageLanguage` + """ + model = PageLanguage() + if include_optional: + return PageLanguage( + items = [ + compute_api_client.models.language.Language( + id = 56, + name = '', + version = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageLanguage( + items = [ + compute_api_client.models.language.Language( + id = 56, + name = '', + version = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageLanguage(self): + """Test PageLanguage""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_member.py b/compute_api_client/test/test_page_member.py new file mode 100644 index 0000000..515d496 --- /dev/null +++ b/compute_api_client/test/test_page_member.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_member import PageMember + +class TestPageMember(unittest.TestCase): + """PageMember unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageMember: + """Test PageMember + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageMember` + """ + model = PageMember() + if include_optional: + return PageMember( + items = [ + compute_api_client.models.member.Member( + id = 56, + team_id = 56, + user_id = 56, + role = 'member', + is_active = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageMember( + items = [ + compute_api_client.models.member.Member( + id = 56, + team_id = 56, + user_id = 56, + role = 'member', + is_active = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageMember(self): + """Test PageMember""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_metadata.py b/compute_api_client/test/test_page_metadata.py new file mode 100644 index 0000000..27b0b1a --- /dev/null +++ b/compute_api_client/test/test_page_metadata.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_metadata import PageMetadata + +class TestPageMetadata(unittest.TestCase): + """PageMetadata unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageMetadata: + """Test PageMetadata + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageMetadata` + """ + model = PageMetadata() + if include_optional: + return PageMetadata( + items = [ + compute_api_client.models.metadata.Metadata( + id = 56, + backend_id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + data = compute_api_client.models.data.Data(), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageMetadata( + items = [ + compute_api_client.models.metadata.Metadata( + id = 56, + backend_id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + data = compute_api_client.models.data.Data(), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageMetadata(self): + """Test PageMetadata""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_permission.py b/compute_api_client/test/test_page_permission.py new file mode 100644 index 0000000..c16f3b1 --- /dev/null +++ b/compute_api_client/test/test_page_permission.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_permission import PagePermission + +class TestPagePermission(unittest.TestCase): + """PagePermission unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PagePermission: + """Test PagePermission + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PagePermission` + """ + model = PagePermission() + if include_optional: + return PagePermission( + items = [ + compute_api_client.models.permission.Permission( + id = 56, + permission = '', + name = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PagePermission( + items = [ + compute_api_client.models.permission.Permission( + id = 56, + permission = '', + name = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPagePermission(self): + """Test PagePermission""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_permission_group.py b/compute_api_client/test/test_page_permission_group.py new file mode 100644 index 0000000..653ed07 --- /dev/null +++ b/compute_api_client/test/test_page_permission_group.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_permission_group import PagePermissionGroup + +class TestPagePermissionGroup(unittest.TestCase): + """PagePermissionGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PagePermissionGroup: + """Test PagePermissionGroup + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PagePermissionGroup` + """ + model = PagePermissionGroup() + if include_optional: + return PagePermissionGroup( + items = [ + compute_api_client.models.permission_group.PermissionGroup( + id = 56, + name = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PagePermissionGroup( + items = [ + compute_api_client.models.permission_group.PermissionGroup( + id = 56, + name = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPagePermissionGroup(self): + """Test PagePermissionGroup""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_project.py b/compute_api_client/test/test_page_project.py new file mode 100644 index 0000000..ca32156 --- /dev/null +++ b/compute_api_client/test/test_page_project.py @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_project import PageProject + +class TestPageProject(unittest.TestCase): + """PageProject unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageProject: + """Test PageProject + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageProject` + """ + model = PageProject() + if include_optional: + return PageProject( + items = [ + compute_api_client.models.project.Project( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + owner_id = 56, + name = '', + description = '', + starred = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageProject( + items = [ + compute_api_client.models.project.Project( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + owner_id = 56, + name = '', + description = '', + starred = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageProject(self): + """Test PageProject""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_reservation.py b/compute_api_client/test/test_page_reservation.py new file mode 100644 index 0000000..40cfcec --- /dev/null +++ b/compute_api_client/test/test_page_reservation.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_reservation import PageReservation + +class TestPageReservation(unittest.TestCase): + """PageReservation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageReservation: + """Test PageReservation + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageReservation` + """ + model = PageReservation() + if include_optional: + return PageReservation( + items = [ + compute_api_client.models.reservation.Reservation( + id = 56, + member_id = 56, + start_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + backend_type_id = 56, + backend_id = 56, + is_terminated = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageReservation( + items = [ + compute_api_client.models.reservation.Reservation( + id = 56, + member_id = 56, + start_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + backend_type_id = 56, + backend_id = 56, + is_terminated = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageReservation(self): + """Test PageReservation""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_result.py b/compute_api_client/test/test_page_result.py new file mode 100644 index 0000000..514c393 --- /dev/null +++ b/compute_api_client/test/test_page_result.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_result import PageResult + +class TestPageResult(unittest.TestCase): + """PageResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageResult: + """Test PageResult + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageResult` + """ + model = PageResult() + if include_optional: + return PageResult( + items = [ + compute_api_client.models.result.Result( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + job_id = 56, + metadata_id = 56, + number_of_qubits = -32768.0, + execution_time_in_seconds = 1.337, + shots_requested = 56, + shots_done = 56, + results = compute_api_client.models.results.results(), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageResult( + items = [ + compute_api_client.models.result.Result( + id = 56, + created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + job_id = 56, + metadata_id = 56, + number_of_qubits = -32768.0, + execution_time_in_seconds = 1.337, + shots_requested = 56, + shots_done = 56, + results = compute_api_client.models.results.results(), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageResult(self): + """Test PageResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_team.py b/compute_api_client/test/test_page_team.py new file mode 100644 index 0000000..ddcbae2 --- /dev/null +++ b/compute_api_client/test/test_page_team.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_team import PageTeam + +class TestPageTeam(unittest.TestCase): + """PageTeam unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageTeam: + """Test PageTeam + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageTeam` + """ + model = PageTeam() + if include_optional: + return PageTeam( + items = [ + compute_api_client.models.team.Team( + id = 56, + name = '', + slug = '', + individual_user = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageTeam( + items = [ + compute_api_client.models.team.Team( + id = 56, + name = '', + slug = '', + individual_user = True, ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageTeam(self): + """Test PageTeam""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_transaction.py b/compute_api_client/test/test_page_transaction.py new file mode 100644 index 0000000..5cef180 --- /dev/null +++ b/compute_api_client/test/test_page_transaction.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_transaction import PageTransaction + +class TestPageTransaction(unittest.TestCase): + """PageTransaction unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageTransaction: + """Test PageTransaction + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageTransaction` + """ + model = PageTransaction() + if include_optional: + return PageTransaction( + items = [ + compute_api_client.models.transaction.Transaction( + id = 56, + domain = 'compute', + job = 56, + team_id = 56, + member_id = 56, + change = -32768.0, + timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageTransaction( + items = [ + compute_api_client.models.transaction.Transaction( + id = 56, + domain = 'compute', + job = 56, + team_id = 56, + member_id = 56, + change = -32768.0, + timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageTransaction(self): + """Test PageTransaction""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/compute_api_client/test/test_page_user.py b/compute_api_client/test/test_page_user.py new file mode 100644 index 0000000..2ac86f8 --- /dev/null +++ b/compute_api_client/test/test_page_user.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + Quantum Inspire 2 + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + + The version of the OpenAPI document: 0.1.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from compute_api_client.models.page_user import PageUser + +class TestPageUser(unittest.TestCase): + """PageUser unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PageUser: + """Test PageUser + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PageUser` + """ + model = PageUser() + if include_optional: + return PageUser( + items = [ + compute_api_client.models.user.User( + id = 56, + full_name = '', + email = '', + is_superuser = True, + is_staff = True, + is_active = True, + is_confirmed = True, + oidc_sub = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + pages = 0.0 + ) + else: + return PageUser( + items = [ + compute_api_client.models.user.User( + id = 56, + full_name = '', + email = '', + is_superuser = True, + is_staff = True, + is_active = True, + is_confirmed = True, + oidc_sub = '', ) + ], + total = 0.0, + page = 1.0, + size = 1.0, + ) + """ + + def testPageUser(self): + """Test PageUser""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/pyproject.toml b/pyproject.toml index 8966bf2..e346418 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "qi-compute-api-client" -version = "0.32.0" +version = "0.33.0" description = "An API client for the Compute Job Manager of Quantum Inspire." license = "Apache-2.0" authors = ["Quantum Inspire "]