Update generated api code (#1399)

lightly-ai · Sep 19, 2023 · be89e9e · be89e9e
1 parent f1f4d5e
commit be89e9e
Show file tree

Hide file tree

Showing 12 changed files with 373 additions and 145 deletions.
diff --git a/lightly/openapi_generated/swagger_client/api/datasources_api.py b/lightly/openapi_generated/swagger_client/api/datasources_api.py
diff --git a/lightly/openapi_generated/swagger_client/api/docker_api.py b/lightly/openapi_generated/swagger_client/api/docker_api.py
@@ -2150,7 +2150,7 @@ def get_docker_run_logs_by_id_with_http_info(self, run_id : Annotated[constr(str
     def get_docker_run_report_read_url_by_id(self, run_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the docker run")], **kwargs) -> str:  # noqa: E501
         """(Deprecated) get_docker_run_report_read_url_by_id  # noqa: E501
 
-        Get the url of a specific docker runs report  # noqa: E501
+        DEPRECATED, use getDockerRunArtifactReadUrlById - Get the url of a specific docker runs report  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2179,7 +2179,7 @@ def get_docker_run_report_read_url_by_id(self, run_id : Annotated[constr(strict=
     def get_docker_run_report_read_url_by_id_with_http_info(self, run_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the docker run")], **kwargs) -> ApiResponse:  # noqa: E501
         """(Deprecated) get_docker_run_report_read_url_by_id  # noqa: E501
 
-        Get the url of a specific docker runs report  # noqa: E501
+        DEPRECATED, use getDockerRunArtifactReadUrlById - Get the url of a specific docker runs report  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2295,7 +2295,7 @@ def get_docker_run_report_read_url_by_id_with_http_info(self, run_id : Annotated
     def get_docker_run_report_write_url_by_id(self, run_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the docker run")], **kwargs) -> str:  # noqa: E501
         """(Deprecated) get_docker_run_report_write_url_by_id  # noqa: E501
 
-        Get the signed url to upload a report of a docker run  # noqa: E501
+        DEPRECATED, use createDockerRunArtifact - Get the signed url to upload a report of a docker run  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2324,7 +2324,7 @@ def get_docker_run_report_write_url_by_id(self, run_id : Annotated[constr(strict
     def get_docker_run_report_write_url_by_id_with_http_info(self, run_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the docker run")], **kwargs) -> ApiResponse:  # noqa: E501
         """(Deprecated) get_docker_run_report_write_url_by_id  # noqa: E501
 
-        Get the signed url to upload a report of a docker run  # noqa: E501
+        DEPRECATED, use createDockerRunArtifact - Get the signed url to upload a report of a docker run  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

diff --git a/lightly/openapi_generated/swagger_client/api/predictions_api.py b/lightly/openapi_generated/swagger_client/api/predictions_api.py
diff --git a/lightly/openapi_generated/swagger_client/api/samples_api.py b/lightly/openapi_generated/swagger_client/api/samples_api.py
@@ -1153,7 +1153,7 @@ def get_sample_image_write_urls_by_id_with_http_info(self, dataset_id : Annotate
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_samples_by_dataset_id(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], file_name : Annotated[Optional[StrictStr], Field(description="filter the samples by filename")] = None, sort_by : Annotated[Optional[SampleSortBy], Field(description="sort the samples")] = None, page_size : Annotated[Optional[conint(strict=True, ge=1)], Field(description="pagination size/limit of the number of samples to return")] = None, page_offset : Annotated[Optional[conint(strict=True, ge=0)], Field(description="pagination offset")] = None, **kwargs) -> List[SampleData]:  # noqa: E501
+    def get_samples_by_dataset_id(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], file_name : Annotated[Optional[StrictStr], Field(description="DEPRECATED, use without and filter yourself - Filter the samples by filename")] = None, sort_by : Annotated[Optional[SampleSortBy], Field(description="sort the samples")] = None, page_size : Annotated[Optional[conint(strict=True, ge=1)], Field(description="pagination size/limit of the number of samples to return")] = None, page_offset : Annotated[Optional[conint(strict=True, ge=0)], Field(description="pagination offset")] = None, **kwargs) -> List[SampleData]:  # noqa: E501
         """get_samples_by_dataset_id  # noqa: E501
 
         Get all samples of a dataset  # noqa: E501
@@ -1165,7 +1165,7 @@ def get_samples_by_dataset_id(self, dataset_id : Annotated[constr(strict=True),
 
         :param dataset_id: ObjectId of the dataset (required)
         :type dataset_id: str
-        :param file_name: filter the samples by filename
+        :param file_name: DEPRECATED, use without and filter yourself - Filter the samples by filename
         :type file_name: str
         :param sort_by: sort the samples
         :type sort_by: SampleSortBy
@@ -1190,7 +1190,7 @@ def get_samples_by_dataset_id(self, dataset_id : Annotated[constr(strict=True),
         return self.get_samples_by_dataset_id_with_http_info(dataset_id, file_name, sort_by, page_size, page_offset, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def get_samples_by_dataset_id_with_http_info(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], file_name : Annotated[Optional[StrictStr], Field(description="filter the samples by filename")] = None, sort_by : Annotated[Optional[SampleSortBy], Field(description="sort the samples")] = None, page_size : Annotated[Optional[conint(strict=True, ge=1)], Field(description="pagination size/limit of the number of samples to return")] = None, page_offset : Annotated[Optional[conint(strict=True, ge=0)], Field(description="pagination offset")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def get_samples_by_dataset_id_with_http_info(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], file_name : Annotated[Optional[StrictStr], Field(description="DEPRECATED, use without and filter yourself - Filter the samples by filename")] = None, sort_by : Annotated[Optional[SampleSortBy], Field(description="sort the samples")] = None, page_size : Annotated[Optional[conint(strict=True, ge=1)], Field(description="pagination size/limit of the number of samples to return")] = None, page_offset : Annotated[Optional[conint(strict=True, ge=0)], Field(description="pagination offset")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """get_samples_by_dataset_id  # noqa: E501
 
         Get all samples of a dataset  # noqa: E501
@@ -1202,7 +1202,7 @@ def get_samples_by_dataset_id_with_http_info(self, dataset_id : Annotated[constr
 
         :param dataset_id: ObjectId of the dataset (required)
         :type dataset_id: str
-        :param file_name: filter the samples by filename
+        :param file_name: DEPRECATED, use without and filter yourself - Filter the samples by filename
         :type file_name: str
         :param sort_by: sort the samples
         :type sort_by: SampleSortBy

diff --git a/lightly/openapi_generated/swagger_client/api/tags_api.py b/lightly/openapi_generated/swagger_client/api/tags_api.py
@@ -524,9 +524,9 @@ def delete_tag_by_tag_id_with_http_info(self, dataset_id : Annotated[constr(stri
 
     @validate_arguments
     def download_zip_of_samples_by_tag_id(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the tag")], **kwargs) -> bytearray:  # noqa: E501
-        """download_zip_of_samples_by_tag_id  # noqa: E501
+        """(Deprecated) download_zip_of_samples_by_tag_id  # noqa: E501
 
-        Download a zip file of the samples of a tag. Limited to 1000 images  # noqa: E501
+        DEPRECATED - Download a zip file of the samples of a tag. Limited to 1000 images  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -555,9 +555,9 @@ def download_zip_of_samples_by_tag_id(self, dataset_id : Annotated[constr(strict
 
     @validate_arguments
     def download_zip_of_samples_by_tag_id_with_http_info(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the tag")], **kwargs) -> ApiResponse:  # noqa: E501
-        """download_zip_of_samples_by_tag_id  # noqa: E501
+        """(Deprecated) download_zip_of_samples_by_tag_id  # noqa: E501
 
-        Download a zip file of the samples of a tag. Limited to 1000 images  # noqa: E501
+        DEPRECATED - Download a zip file of the samples of a tag. Limited to 1000 images  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -593,6 +593,8 @@ def download_zip_of_samples_by_tag_id_with_http_info(self, dataset_id : Annotate
         :rtype: tuple(bytearray, status_code(int), headers(HTTPHeaderDict))
         """
 
+        warnings.warn("GET /v1/datasets/{datasetId}/tags/{tagId}/export/zip is deprecated.", DeprecationWarning)
+
         _params = locals()
 
         _all_params = [
@@ -1112,7 +1114,7 @@ def export_tag_to_basic_filenames_and_read_urls_with_http_info(self, dataset_id
     def export_tag_to_label_box_data_rows(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the tag")], expires_in : Annotated[Optional[StrictInt], Field(description="If defined, the URLs provided will only be valid for amount of seconds from time of issuence. If not defined, the URls will be valid indefinitely. ")] = None, access_control : Annotated[Optional[StrictStr], Field(description="which access control name to be used")] = None, file_name_format : Optional[FileNameFormat] = None, include_meta_data : Annotated[Optional[StrictBool], Field(description="if true, will also include metadata")] = None, format : Optional[FileOutputFormat] = None, preview_example : Annotated[Optional[StrictBool], Field(description="if true, will generate a preview example of how the structure will look")] = None, page_size : Annotated[Optional[conint(strict=True, ge=1)], Field(description="pagination size/limit of the number of samples to return")] = None, page_offset : Annotated[Optional[conint(strict=True, ge=0)], Field(description="pagination offset")] = None, **kwargs) -> List[LabelBoxDataRow]:  # noqa: E501
         """(Deprecated) export_tag_to_label_box_data_rows  # noqa: E501
 
-        Deprecated. Please use V4 unless there is a specific need to use the LabelBox V3 API. Export samples of a tag as a json for importing into LabelBox as outlined here; https://docs.labelbox.com/v3/reference/image ```openapi\\+warning The image URLs are special in that the resource can be accessed by anyone in possession of said URL for the time specified by the expiresIn query param ```   # noqa: E501
+        DEPRECATED - Please use V4 unless there is a specific need to use the LabelBox V3 API. Export samples of a tag as a json for importing into LabelBox as outlined here; https://docs.labelbox.com/v3/reference/image ```openapi\\+warning The image URLs are special in that the resource can be accessed by anyone in possession of said URL for the time specified by the expiresIn query param ```   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -1159,7 +1161,7 @@ def export_tag_to_label_box_data_rows(self, dataset_id : Annotated[constr(strict
     def export_tag_to_label_box_data_rows_with_http_info(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the tag")], expires_in : Annotated[Optional[StrictInt], Field(description="If defined, the URLs provided will only be valid for amount of seconds from time of issuence. If not defined, the URls will be valid indefinitely. ")] = None, access_control : Annotated[Optional[StrictStr], Field(description="which access control name to be used")] = None, file_name_format : Optional[FileNameFormat] = None, include_meta_data : Annotated[Optional[StrictBool], Field(description="if true, will also include metadata")] = None, format : Optional[FileOutputFormat] = None, preview_example : Annotated[Optional[StrictBool], Field(description="if true, will generate a preview example of how the structure will look")] = None, page_size : Annotated[Optional[conint(strict=True, ge=1)], Field(description="pagination size/limit of the number of samples to return")] = None, page_offset : Annotated[Optional[conint(strict=True, ge=0)], Field(description="pagination offset")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """(Deprecated) export_tag_to_label_box_data_rows  # noqa: E501
 
-        Deprecated. Please use V4 unless there is a specific need to use the LabelBox V3 API. Export samples of a tag as a json for importing into LabelBox as outlined here; https://docs.labelbox.com/v3/reference/image ```openapi\\+warning The image URLs are special in that the resource can be accessed by anyone in possession of said URL for the time specified by the expiresIn query param ```   # noqa: E501
+        DEPRECATED - Please use V4 unless there is a specific need to use the LabelBox V3 API. Export samples of a tag as a json for importing into LabelBox as outlined here; https://docs.labelbox.com/v3/reference/image ```openapi\\+warning The image URLs are special in that the resource can be accessed by anyone in possession of said URL for the time specified by the expiresIn query param ```   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2070,7 +2072,7 @@ def export_tag_to_sama_tasks_with_http_info(self, dataset_id : Annotated[constr(
     def get_filenames_by_tag_id(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the tag")], **kwargs) -> List[str]:  # noqa: E501
         """(Deprecated) get_filenames_by_tag_id  # noqa: E501
 
-        Get list of filenames by tag. Deprecated, please use  # noqa: E501
+        DEPRECATED, please use exportTagToBasicFilenames - Get list of filenames by tag.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2101,7 +2103,7 @@ def get_filenames_by_tag_id(self, dataset_id : Annotated[constr(strict=True), Fi
     def get_filenames_by_tag_id_with_http_info(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the tag")], **kwargs) -> ApiResponse:  # noqa: E501
         """(Deprecated) get_filenames_by_tag_id  # noqa: E501
 
-        Get list of filenames by tag. Deprecated, please use  # noqa: E501
+        DEPRECATED, please use exportTagToBasicFilenames - Get list of filenames by tag.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2675,7 +2677,7 @@ def perform_tag_arithmetics_with_http_info(self, dataset_id : Annotated[constr(s
     def perform_tag_arithmetics_bitmask(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_arithmetics_request : TagArithmeticsRequest, **kwargs) -> TagBitMaskResponse:  # noqa: E501
         """(Deprecated) perform_tag_arithmetics_bitmask  # noqa: E501
 
-        Performs tag arithmetics to compute a new bitmask out of two existing tags. Does not create a new tag regardless if newTagName is provided  # noqa: E501
+        DEPRECATED, use performTagArithmetics - Performs tag arithmetics to compute a new bitmask out of two existing tags. Does not create a new tag regardless if newTagName is provided  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -2706,7 +2708,7 @@ def perform_tag_arithmetics_bitmask(self, dataset_id : Annotated[constr(strict=T
     def perform_tag_arithmetics_bitmask_with_http_info(self, dataset_id : Annotated[constr(strict=True), Field(..., description="ObjectId of the dataset")], tag_arithmetics_request : TagArithmeticsRequest, **kwargs) -> ApiResponse:  # noqa: E501
         """(Deprecated) perform_tag_arithmetics_bitmask  # noqa: E501
 
-        Performs tag arithmetics to compute a new bitmask out of two existing tags. Does not create a new tag regardless if newTagName is provided  # noqa: E501
+        DEPRECATED, use performTagArithmetics - Performs tag arithmetics to compute a new bitmask out of two existing tags. Does not create a new tag regardless if newTagName is provided  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

diff --git a/lightly/openapi_generated/swagger_client/api/teams_api.py b/lightly/openapi_generated/swagger_client/api/teams_api.py
@@ -51,7 +51,7 @@ def __init__(self, api_client=None):
         self.api_client = api_client
 
     @validate_arguments
-    def add_team_member(self, team_id : Annotated[constr(strict=True), Field(..., description="id of the team")], create_team_membership_request : CreateTeamMembershipRequest, **kwargs) -> None:  # noqa: E501
+    def add_team_member(self, team_id : Annotated[constr(strict=True), Field(..., description="id of the team")], create_team_membership_request : CreateTeamMembershipRequest, **kwargs) -> str:  # noqa: E501
         """add_team_member  # noqa: E501
 
         Add a team member. One needs to be part of the team to do so.  # noqa: E501
@@ -74,7 +74,7 @@ def add_team_member(self, team_id : Annotated[constr(strict=True), Field(..., de
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: None
+        :rtype: str
         """
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
@@ -118,7 +118,7 @@ def add_team_member_with_http_info(self, team_id : Annotated[constr(strict=True)
         :return: Returns the result object.
                  If the method is called asynchronously,
                  returns the request thread.
-        :rtype: None
+        :rtype: tuple(str, status_code(int), headers(HTTPHeaderDict))
         """
 
         _params = locals()
@@ -171,7 +171,7 @@ def add_team_member_with_http_info(self, team_id : Annotated[constr(strict=True)
 
         # set the HTTP header `Accept`
         _header_params['Accept'] = self.api_client.select_header_accept(
-            ['application/json'])  # noqa: E501
+            ['text/plain', 'application/json'])  # noqa: E501
 
         # set the HTTP header `Content-Type`
         _content_types_list = _params.get('_content_type',
@@ -183,7 +183,13 @@ def add_team_member_with_http_info(self, team_id : Annotated[constr(strict=True)
         # authentication setting
         _auth_settings = ['auth0Bearer', 'ApiKeyAuth']  # noqa: E501
 
-        _response_types_map = {}
+        _response_types_map = {
+            '200': "str",
+            '400': "ApiErrorResponse",
+            '401': "ApiErrorResponse",
+            '403': "ApiErrorResponse",
+            '404': "ApiErrorResponse",
+        }
 
         return self.api_client.call_api(
             '/v1/teams/{teamId}/members', 'POST',