wds-client 0.15.0__tar.gz → 0.17.0__tar.gz

{wds_client-0.15.0 → wds_client-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wds-client
-Version: 0.15.0
+Version: 0.17.0
 Summary: Workspace Data Service
 Home-page: 
 Author: OpenAPI Generator community

{wds_client-0.15.0 → wds_client-0.17.0}/README.md

@@ -9,7 +9,7 @@ Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/rele
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v0.2
-- Package version: 0.15.0
+- Package version: 0.17.0
 - Generator version: 7.7.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -119,6 +119,7 @@ Class | Method | HTTP request | Description
 *SchemaApi* | [**describe_all_record_types**](docs/SchemaApi.md#describe_all_record_types) | **GET** /{instanceid}/types/{v} | Describe all record types
 *SchemaApi* | [**describe_record_type**](docs/SchemaApi.md#describe_record_type) | **GET** /{instanceid}/types/{v}/{type} | Describe record type
 *SchemaApi* | [**update_attribute**](docs/SchemaApi.md#update_attribute) | **PATCH** /{instanceid}/types/{v}/{type}/{attribute} | Update an attribute
+*WorkspaceApi* | [**init_workspace_v1**](docs/WorkspaceApi.md#init_workspace_v1) | **POST** /workspaces/v1/{workspaceId} | Initialize WDS for a given workspace.
 
 
 ## Documentation For Models
@@ -138,6 +139,7 @@ Class | Method | HTTP request | Description
  - [CloneJob](docs/CloneJob.md)
  - [CloneResponse](docs/CloneResponse.md)
  - [Collection](docs/Collection.md)
+ - [CollectionRequest](docs/CollectionRequest.md)
  - [Commit](docs/Commit.md)
  - [ErrorResponse](docs/ErrorResponse.md)
  - [GenericJob](docs/GenericJob.md)
@@ -155,6 +157,8 @@ Class | Method | HTTP request | Description
  - [StatusResponse](docs/StatusResponse.md)
  - [TsvUploadResponse](docs/TsvUploadResponse.md)
  - [VersionResponse](docs/VersionResponse.md)
+ - [WorkspaceInit](docs/WorkspaceInit.md)
+ - [WorkspaceInitClone](docs/WorkspaceInitClone.md)
 
 
 <a id="documentation-for-authorization"></a>

{wds_client-0.15.0 → wds_client-0.17.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wds_client"
-version = "0.15.0"
+version = "0.17.0"
 description = "Workspace Data Service"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "BSD"

{wds_client-0.15.0 → wds_client-0.17.0}/setup.py

@@ -21,7 +21,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "wds-client"
-VERSION = "0.15.0"
+VERSION = "0.17.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

wds_client-0.17.0/test/test_collection_request.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+"""
+    Workspace Data Service
+
+    This page lists current APIs.  All v0.2 APIs are subject to change without notice.  Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/releases](https://github.com/DataBiosphere/terra-workspace-data-service/releases) 
+
+    The version of the OpenAPI document: v0.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from wds_client.models.collection_request import CollectionRequest
+
+class TestCollectionRequest(unittest.TestCase):
+    """CollectionRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> CollectionRequest:
+        """Test CollectionRequest
+            include_optional 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 `CollectionRequest`
+        """
+        model = CollectionRequest()
+        if include_optional:
+            return CollectionRequest(
+                name = 'zBAMDTMv2D2ylmgd10Z3UB6UkJSISSB512iz2DiJykO4IVP7YNsKQHh9BsaMPOiOuo3_QLOpkBmKIPOf2Flbsh1TpRS00P',
+                description = ''
+            )
+        else:
+            return CollectionRequest(
+                name = 'zBAMDTMv2D2ylmgd10Z3UB6UkJSISSB512iz2DiJykO4IVP7YNsKQHh9BsaMPOiOuo3_QLOpkBmKIPOf2Flbsh1TpRS00P',
+                description = '',
+        )
+        """
+
+    def testCollectionRequest(self):
+        """Test CollectionRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

{wds_client-0.15.0 → wds_client-0.17.0}/test/test_record_query_response.py

@@ -43,7 +43,8 @@ class TestRecordQueryResponse(unittest.TestCase):
                     filter = wds_client.models.search_filter.SearchFilter(
                         ids = [
                             ''
-                            ], ), ),
+                            ], 
+                        query = 'sample_id:12345', ), ),
                 total_records = 56,
                 records = [
                     wds_client.models.record_response.RecordResponse(
@@ -76,7 +77,8 @@ class TestRecordQueryResponse(unittest.TestCase):
                     filter = wds_client.models.search_filter.SearchFilter(
                         ids = [
                             ''
-                            ], ), ),
+                            ], 
+                        query = 'sample_id:12345', ), ),
                 total_records = 56,
                 records = [
                     wds_client.models.record_response.RecordResponse(

{wds_client-0.15.0 → wds_client-0.17.0}/test/test_search_filter.py

@@ -37,7 +37,8 @@ class TestSearchFilter(unittest.TestCase):
             return SearchFilter(
                 ids = [
                     ''
-                    ]
+                    ],
+                query = 'sample_id:12345'
             )
         else:
             return SearchFilter(

{wds_client-0.15.0 → wds_client-0.17.0}/test/test_search_request.py

@@ -42,7 +42,8 @@ class TestSearchRequest(unittest.TestCase):
                 filter = wds_client.models.search_filter.SearchFilter(
                     ids = [
                         ''
-                        ], )
+                        ], 
+                    query = 'sample_id:12345', )
             )
         else:
             return SearchRequest(

wds_client-0.17.0/test/test_workspace_api.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Workspace Data Service
+
+    This page lists current APIs.  All v0.2 APIs are subject to change without notice.  Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/releases](https://github.com/DataBiosphere/terra-workspace-data-service/releases) 
+
+    The version of the OpenAPI document: v0.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from wds_client.api.workspace_api import WorkspaceApi
+
+
+class TestWorkspaceApi(unittest.TestCase):
+    """WorkspaceApi unit test stubs"""
+
+    def setUp(self) -> None:
+        self.api = WorkspaceApi()
+
+    def tearDown(self) -> None:
+        pass
+
+    def test_init_workspace_v1(self) -> None:
+        """Test case for init_workspace_v1
+
+        Initialize WDS for a given workspace.
+        """
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

wds_client-0.17.0/test/test_workspace_init.py

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+"""
+    Workspace Data Service
+
+    This page lists current APIs.  All v0.2 APIs are subject to change without notice.  Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/releases](https://github.com/DataBiosphere/terra-workspace-data-service/releases) 
+
+    The version of the OpenAPI document: v0.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from wds_client.models.workspace_init import WorkspaceInit
+
+class TestWorkspaceInit(unittest.TestCase):
+    """WorkspaceInit unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> WorkspaceInit:
+        """Test WorkspaceInit
+            include_optional 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 `WorkspaceInit`
+        """
+        model = WorkspaceInit()
+        if include_optional:
+            return WorkspaceInit(
+                clone = wds_client.models.workspace_init_clone.WorkspaceInitClone(
+                    source_workspace_id = '', )
+            )
+        else:
+            return WorkspaceInit(
+        )
+        """
+
+    def testWorkspaceInit(self):
+        """Test WorkspaceInit"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

wds_client-0.17.0/test/test_workspace_init_clone.py

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+"""
+    Workspace Data Service
+
+    This page lists current APIs.  All v0.2 APIs are subject to change without notice.  Changelog at [https://github.com/DataBiosphere/terra-workspace-data-service/releases](https://github.com/DataBiosphere/terra-workspace-data-service/releases) 
+
+    The version of the OpenAPI document: v0.2
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from wds_client.models.workspace_init_clone import WorkspaceInitClone
+
+class TestWorkspaceInitClone(unittest.TestCase):
+    """WorkspaceInitClone unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> WorkspaceInitClone:
+        """Test WorkspaceInitClone
+            include_optional 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 `WorkspaceInitClone`
+        """
+        model = WorkspaceInitClone()
+        if include_optional:
+            return WorkspaceInitClone(
+                source_workspace_id = ''
+            )
+        else:
+            return WorkspaceInitClone(
+                source_workspace_id = '',
+        )
+        """
+
+    def testWorkspaceInitClone(self):
+        """Test WorkspaceInitClone"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

{wds_client-0.15.0 → wds_client-0.17.0}/wds_client/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "0.15.0"
+__version__ = "0.17.0"
 
 # import apis into sdk package
 from wds_client.api.capabilities_api import CapabilitiesApi
@@ -26,6 +26,7 @@ from wds_client.api.instances_api import InstancesApi
 from wds_client.api.job_api import JobApi
 from wds_client.api.records_api import RecordsApi
 from wds_client.api.schema_api import SchemaApi
+from wds_client.api.workspace_api import WorkspaceApi
 
 # import ApiClient
 from wds_client.api_response import ApiResponse
@@ -54,6 +55,7 @@ from wds_client.models.capabilities import Capabilities
 from wds_client.models.clone_job import CloneJob
 from wds_client.models.clone_response import CloneResponse
 from wds_client.models.collection import Collection
+from wds_client.models.collection_request import CollectionRequest
 from wds_client.models.commit import Commit
 from wds_client.models.error_response import ErrorResponse
 from wds_client.models.generic_job import GenericJob
@@ -71,3 +73,5 @@ from wds_client.models.search_sort_direction import SearchSortDirection
 from wds_client.models.status_response import StatusResponse
 from wds_client.models.tsv_upload_response import TsvUploadResponse
 from wds_client.models.version_response import VersionResponse
+from wds_client.models.workspace_init import WorkspaceInit
+from wds_client.models.workspace_init_clone import WorkspaceInitClone

{wds_client-0.15.0 → wds_client-0.17.0}/wds_client/api/__init__.py

@@ -10,4 +10,5 @@ from wds_client.api.instances_api import InstancesApi
 from wds_client.api.job_api import JobApi
 from wds_client.api.records_api import RecordsApi
 from wds_client.api.schema_api import SchemaApi
+from wds_client.api.workspace_api import WorkspaceApi
 

{wds_client-0.15.0 → wds_client-0.17.0}/wds_client/api/collection_api.py

@@ -20,6 +20,7 @@ from pydantic import Field, StrictStr
 from typing import List
 from typing_extensions import Annotated
 from wds_client.models.collection import Collection
+from wds_client.models.collection_request import CollectionRequest
 
 from wds_client.api_client import ApiClient, RequestSerialized
 from wds_client.api_response import ApiResponse
@@ -43,7 +44,7 @@ class CollectionApi:
     def create_collection_v1(
         self,
         workspace_id: Annotated[StrictStr, Field(description="Workspace id")],
-        collection: Annotated[Collection, Field(description="The collection to create")],
+        collection_request: Annotated[CollectionRequest, Field(description="The collection to create")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -59,12 +60,11 @@ class CollectionApi:
     ) -> Collection:
         """Create a collection in this workspace.
 
-        If collection id is specified in the request body, it must be a valid UUID. If omitted, the system will generate an id. 
 
         :param workspace_id: Workspace id (required)
         :type workspace_id: str
-        :param collection: The collection to create (required)
-        :type collection: Collection
+        :param collection_request: The collection to create (required)
+        :type collection_request: CollectionRequest
         :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
@@ -89,7 +89,7 @@ class CollectionApi:
 
         _param = self._create_collection_v1_serialize(
             workspace_id=workspace_id,
-            collection=collection,
+            collection_request=collection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -114,7 +114,7 @@ class CollectionApi:
     def create_collection_v1_with_http_info(
         self,
         workspace_id: Annotated[StrictStr, Field(description="Workspace id")],
-        collection: Annotated[Collection, Field(description="The collection to create")],
+        collection_request: Annotated[CollectionRequest, Field(description="The collection to create")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -130,12 +130,11 @@ class CollectionApi:
     ) -> ApiResponse[Collection]:
         """Create a collection in this workspace.
 
-        If collection id is specified in the request body, it must be a valid UUID. If omitted, the system will generate an id. 
 
         :param workspace_id: Workspace id (required)
         :type workspace_id: str
-        :param collection: The collection to create (required)
-        :type collection: Collection
+        :param collection_request: The collection to create (required)
+        :type collection_request: CollectionRequest
         :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
@@ -160,7 +159,7 @@ class CollectionApi:
 
         _param = self._create_collection_v1_serialize(
             workspace_id=workspace_id,
-            collection=collection,
+            collection_request=collection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -185,7 +184,7 @@ class CollectionApi:
     def create_collection_v1_without_preload_content(
         self,
         workspace_id: Annotated[StrictStr, Field(description="Workspace id")],
-        collection: Annotated[Collection, Field(description="The collection to create")],
+        collection_request: Annotated[CollectionRequest, Field(description="The collection to create")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -201,12 +200,11 @@ class CollectionApi:
     ) -> RESTResponseType:
         """Create a collection in this workspace.
 
-        If collection id is specified in the request body, it must be a valid UUID. If omitted, the system will generate an id. 
 
         :param workspace_id: Workspace id (required)
         :type workspace_id: str
-        :param collection: The collection to create (required)
-        :type collection: Collection
+        :param collection_request: The collection to create (required)
+        :type collection_request: CollectionRequest
         :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
@@ -231,7 +229,7 @@ class CollectionApi:
 
         _param = self._create_collection_v1_serialize(
             workspace_id=workspace_id,
-            collection=collection,
+            collection_request=collection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -251,7 +249,7 @@ class CollectionApi:
     def _create_collection_v1_serialize(
         self,
         workspace_id,
-        collection,
+        collection_request,
         _request_auth,
         _content_type,
         _headers,
@@ -277,8 +275,8 @@ class CollectionApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if collection is not None:
-            _body_params = collection
+        if collection_request is not None:
+            _body_params = collection_request
 
 
         # set the HTTP header `Accept`
@@ -1122,7 +1120,7 @@ class CollectionApi:
         self,
         workspace_id: Annotated[StrictStr, Field(description="Workspace id")],
         collection_id: Annotated[StrictStr, Field(description="Collection id")],
-        collection: Annotated[Collection, Field(description="The collection to update")],
+        collection_request: Annotated[CollectionRequest, Field(description="The collection to update")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1138,14 +1136,13 @@ class CollectionApi:
     ) -> Collection:
         """Update the specified collection.
 
-        Collection id is optional in the request body. If specified, it must match the collection id specified in the url. 
 
         :param workspace_id: Workspace id (required)
         :type workspace_id: str
         :param collection_id: Collection id (required)
         :type collection_id: str
-        :param collection: The collection to update (required)
-        :type collection: Collection
+        :param collection_request: The collection to update (required)
+        :type collection_request: CollectionRequest
         :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
@@ -1171,7 +1168,7 @@ class CollectionApi:
         _param = self._update_collection_v1_serialize(
             workspace_id=workspace_id,
             collection_id=collection_id,
-            collection=collection,
+            collection_request=collection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1197,7 +1194,7 @@ class CollectionApi:
         self,
         workspace_id: Annotated[StrictStr, Field(description="Workspace id")],
         collection_id: Annotated[StrictStr, Field(description="Collection id")],
-        collection: Annotated[Collection, Field(description="The collection to update")],
+        collection_request: Annotated[CollectionRequest, Field(description="The collection to update")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1213,14 +1210,13 @@ class CollectionApi:
     ) -> ApiResponse[Collection]:
         """Update the specified collection.
 
-        Collection id is optional in the request body. If specified, it must match the collection id specified in the url. 
 
         :param workspace_id: Workspace id (required)
         :type workspace_id: str
         :param collection_id: Collection id (required)
         :type collection_id: str
-        :param collection: The collection to update (required)
-        :type collection: Collection
+        :param collection_request: The collection to update (required)
+        :type collection_request: CollectionRequest
         :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
@@ -1246,7 +1242,7 @@ class CollectionApi:
         _param = self._update_collection_v1_serialize(
             workspace_id=workspace_id,
             collection_id=collection_id,
-            collection=collection,
+            collection_request=collection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1272,7 +1268,7 @@ class CollectionApi:
         self,
         workspace_id: Annotated[StrictStr, Field(description="Workspace id")],
         collection_id: Annotated[StrictStr, Field(description="Collection id")],
-        collection: Annotated[Collection, Field(description="The collection to update")],
+        collection_request: Annotated[CollectionRequest, Field(description="The collection to update")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1288,14 +1284,13 @@ class CollectionApi:
     ) -> RESTResponseType:
         """Update the specified collection.
 
-        Collection id is optional in the request body. If specified, it must match the collection id specified in the url. 
 
         :param workspace_id: Workspace id (required)
         :type workspace_id: str
         :param collection_id: Collection id (required)
         :type collection_id: str
-        :param collection: The collection to update (required)
-        :type collection: Collection
+        :param collection_request: The collection to update (required)
+        :type collection_request: CollectionRequest
         :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
@@ -1321,7 +1316,7 @@ class CollectionApi:
         _param = self._update_collection_v1_serialize(
             workspace_id=workspace_id,
             collection_id=collection_id,
-            collection=collection,
+            collection_request=collection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1342,7 +1337,7 @@ class CollectionApi:
         self,
         workspace_id,
         collection_id,
-        collection,
+        collection_request,
         _request_auth,
         _content_type,
         _headers,
@@ -1370,8 +1365,8 @@ class CollectionApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if collection is not None:
-            _body_params = collection
+        if collection_request is not None:
+            _body_params = collection_request
 
 
         # set the HTTP header `Accept`