Merge pull request #4 from NarrativeScience/v0.1.3

ns-axu · web-flow · commit 06e1a04f5c3b · 2020-02-25T10:54:47.000-06:00
changes:
* fix property names for Metadata schema 
* fix schema for update stream request body
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ https://www.stitchdata.com/docs/developers/stitch-connect/api
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 0.1
-- Package version: 0.1.2
+- Package version: 0.1.3
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 Table of Contents:
@@ -108,6 +108,7 @@ Class | Method | HTTP request | Description
 - [Stream](docs/Stream.md)
 - [StreamLevelMetadata](docs/StreamLevelMetadata.md)
 - [StreamSchema](docs/StreamSchema.md)
+- [StreamsUpdate](docs/StreamsUpdate.md)
 - [UpdateSourceBody](docs/UpdateSourceBody.md)
 
 
@@ -145,6 +146,6 @@ npx openapi-generator generate \
     --package-name stitch_connect_client \
     --git-user-id NarrativeScience \
     --git-repo-id stitch-connect-python \
-    -p packageVersion=0.1.2 \
+    -p packageVersion=0.1.3 \
     -t templates
 ```
diff --git a/docs/Metadata.md b/docs/Metadata.md
@@ -4,8 +4,8 @@ A Metadata object describes a stream’s schema and the current state of its con
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**breadcrumbs** | **list[str]** | An array of strings describing a path into the schema. For example: A value of [] refers to the entire schema, or stream A value of [\&quot;properties\&quot;, \&quot;&lt;FIELD_NAME&gt;\&quot;] refers to the properties.&lt;FIELD_NAME&gt; portion of the schema. For example: [\&quot;properties\&quot;, \&quot;id\&quot;] would refer to a field named &#x60;id&#x60;  | 
-**metadata_object** | [**MetadataObject**](MetadataObject.md) |  | 
+**breadcrumb** | **list[str]** | An array of strings describing a path into the schema. For example: A value of [] refers to the entire schema, or stream A value of [\&quot;properties\&quot;, \&quot;&lt;FIELD_NAME&gt;\&quot;] refers to the properties.&lt;FIELD_NAME&gt; portion of the schema. For example: [\&quot;properties\&quot;, \&quot;id\&quot;] would refer to a field named &#x60;id&#x60;  | 
+**metadata** | [**MetadataObject**](MetadataObject.md) |  | 
 
 [[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/docs/Stream.md b/docs/Stream.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **selected** | **bool** | Indicates if the stream is selected for replication. Possible values are: null - Only present if a stream has never been selected. Otherwise, this value will be true if selected, and false if de-selected. true - The stream is selected and data will be replicated for all selected fields false - The stream is not selected and data for this stream will not be replicated  | [optional] 
 **stream_name** | **str** | The name of the stream. This value may not be unique. For example: A database with multiple schemas can have the same stream name in multiple schemas.  | [optional] 
 **tap_stream_id** | **str** | The unique version of the stream name. For database sources, this value will be the database name, schema name, and table name, combined.  | [optional] 
-**metadata** | [**StreamLevelMetadata**](StreamLevelMetadata.md) |  | [optional] 
+**metadata** | [**list[StreamLevelMetadata]**](StreamLevelMetadata.md) |  | [optional] 
 
 [[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/docs/StreamsApi.md b/docs/StreamsApi.md
@@ -129,7 +129,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)
 
 # **update_stream_metadata**
-> update_stream_metadata(source_id, stream)
+> update_stream_metadata(source_id, streams_update)
 
 Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema object’s non-discoverable-metadata-keys property. 
 
@@ -151,11 +151,11 @@ configuration.host = "https://api.stitchdata.com"
 # Create an instance of the API class
 api_instance = stitch_connect_client.StreamsApi(stitch_connect_client.ApiClient(configuration))
 source_id = 'source_id_example' # str | The ID of the source
-stream = [stitch_connect_client.Stream()] # list[Stream] | Array of streams to update metadata for
+streams_update = stitch_connect_client.StreamsUpdate() # StreamsUpdate | Array of streams to update metadata for
 
 try:
     # Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema object’s non-discoverable-metadata-keys property. 
-    api_instance.update_stream_metadata(source_id, stream)
+    api_instance.update_stream_metadata(source_id, streams_update)
 except ApiException as e:
     print("Exception when calling StreamsApi->update_stream_metadata: %s\n" % e)
 ```
@@ -165,7 +165,7 @@ except ApiException as e:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **source_id** | **str**| The ID of the source | 
- **stream** | [**list[Stream]**](Stream.md)| Array of streams to update metadata for | 
+ **streams_update** | [**StreamsUpdate**](StreamsUpdate.md)| Array of streams to update metadata for | 
 
 ### Return type
 
diff --git a/docs/StreamsUpdate.md b/docs/StreamsUpdate.md
@@ -0,0 +1,11 @@
+# StreamsUpdate
+
+Object containing a list of stream objects with information to update
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**streams** | [**list[Stream]**](Stream.md) | List of Streams to update | [optional] 
+
+[[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/setup.py b/setup.py
@@ -13,7 +13,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "stitch-connect-client"
-VERSION = "0.1.2"
+VERSION = "0.1.3"
 # To install the library, run the following
 #
 # python setup.py install
diff --git a/stitch_connect_client/__init__.py b/stitch_connect_client/__init__.py
@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "0.1.2"
+__version__ = "0.1.3"
 
 # import apis into sdk package
 from stitch_connect_client.api.destinations_api import DestinationsApi
@@ -60,5 +60,6 @@
 from stitch_connect_client.models.stream import Stream
 from stitch_connect_client.models.stream_level_metadata import StreamLevelMetadata
 from stitch_connect_client.models.stream_schema import StreamSchema
+from stitch_connect_client.models.streams_update import StreamsUpdate
 from stitch_connect_client.models.update_source_body import UpdateSourceBody
 
diff --git a/stitch_connect_client/api/streams_api.py b/stitch_connect_client/api/streams_api.py
@@ -256,17 +256,17 @@ def get_streams_with_http_info(self, source_id, **kwargs):  # noqa: E501
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def update_stream_metadata(self, source_id, stream, **kwargs):  # noqa: E501
+    def update_stream_metadata(self, source_id, streams_update, **kwargs):  # noqa: E501
         """Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema object’s non-discoverable-metadata-keys property.   # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.update_stream_metadata(source_id, stream, async_req=True)
+        >>> thread = api.update_stream_metadata(source_id, streams_update, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool: execute request asynchronously
         :param str source_id: The ID of the source (required)
-        :param list[Stream] stream: Array of streams to update metadata for (required)
+        :param StreamsUpdate streams_update: Array of streams to update metadata for (required)
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -279,19 +279,19 @@ def update_stream_metadata(self, source_id, stream, **kwargs):  # noqa: E501
                  returns the request thread.
         """
         kwargs['_return_http_data_only'] = True
-        return self.update_stream_metadata_with_http_info(source_id, stream, **kwargs)  # noqa: E501
+        return self.update_stream_metadata_with_http_info(source_id, streams_update, **kwargs)  # noqa: E501
 
-    def update_stream_metadata_with_http_info(self, source_id, stream, **kwargs):  # noqa: E501
+    def update_stream_metadata_with_http_info(self, source_id, streams_update, **kwargs):  # noqa: E501
         """Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema object’s non-discoverable-metadata-keys property.   # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
-        >>> thread = api.update_stream_metadata_with_http_info(source_id, stream, async_req=True)
+        >>> thread = api.update_stream_metadata_with_http_info(source_id, streams_update, async_req=True)
         >>> result = thread.get()
 
         :param async_req bool: execute request asynchronously
         :param str source_id: The ID of the source (required)
-        :param list[Stream] stream: Array of streams to update metadata for (required)
+        :param StreamsUpdate streams_update: Array of streams to update metadata for (required)
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -308,7 +308,7 @@ def update_stream_metadata_with_http_info(self, source_id, stream, **kwargs):  #
 
         local_var_params = locals()
 
-        all_params = ['source_id', 'stream']  # noqa: E501
+        all_params = ['source_id', 'streams_update']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -326,10 +326,10 @@ def update_stream_metadata_with_http_info(self, source_id, stream, **kwargs):  #
         if self.api_client.client_side_validation and ('source_id' not in local_var_params or  # noqa: E501
                                                         local_var_params['source_id'] is None):  # noqa: E501
             raise ApiValueError("Missing the required parameter `source_id` when calling `update_stream_metadata`")  # noqa: E501
-        # verify the required parameter 'stream' is set
-        if self.api_client.client_side_validation and ('stream' not in local_var_params or  # noqa: E501
-                                                        local_var_params['stream'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `stream` when calling `update_stream_metadata`")  # noqa: E501
+        # verify the required parameter 'streams_update' is set
+        if self.api_client.client_side_validation and ('streams_update' not in local_var_params or  # noqa: E501
+                                                        local_var_params['streams_update'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `streams_update` when calling `update_stream_metadata`")  # noqa: E501
 
         collection_formats = {}
 
@@ -345,8 +345,8 @@ def update_stream_metadata_with_http_info(self, source_id, stream, **kwargs):  #
         local_var_files = {}
 
         body_params = None
-        if 'stream' in local_var_params:
-            body_params = local_var_params['stream']
+        if 'streams_update' in local_var_params:
+            body_params = local_var_params['streams_update']
         # HTTP header `Content-Type`
         header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
             ['application/json'])  # noqa: E501
diff --git a/stitch_connect_client/api_client.py b/stitch_connect_client/api_client.py
@@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.1.2/python'
+        self.user_agent = 'OpenAPI-Generator/0.1.3/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __del__(self):
diff --git a/stitch_connect_client/configuration.py b/stitch_connect_client/configuration.py
@@ -260,7 +260,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.1\n"\
-               "SDK Package Version: 0.1.2".\
+               "SDK Package Version: 0.1.3".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):
diff --git a/stitch_connect_client/models/__init__.py b/stitch_connect_client/models/__init__.py
@@ -44,4 +44,5 @@
 from stitch_connect_client.models.stream import Stream
 from stitch_connect_client.models.stream_level_metadata import StreamLevelMetadata
 from stitch_connect_client.models.stream_schema import StreamSchema
+from stitch_connect_client.models.streams_update import StreamsUpdate
 from stitch_connect_client.models.update_source_body import UpdateSourceBody
diff --git a/stitch_connect_client/models/metadata.py b/stitch_connect_client/models/metadata.py
@@ -33,75 +33,75 @@ class Metadata(object):
                             and the value is json key in definition.
     """
     openapi_types = {
-        'breadcrumbs': 'list[str]',
-        'metadata_object': 'MetadataObject'
+        'breadcrumb': 'list[str]',
+        'metadata': 'MetadataObject'
     }
 
     attribute_map = {
-        'breadcrumbs': 'breadcrumbs',
-        'metadata_object': 'metadata-object'
+        'breadcrumb': 'breadcrumb',
+        'metadata': 'metadata'
     }
 
-    def __init__(self, breadcrumbs=None, metadata_object=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, breadcrumb=None, metadata=None, local_vars_configuration=None):  # noqa: E501
         """Metadata - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
         self.local_vars_configuration = local_vars_configuration
 
-        self._breadcrumbs = None
-        self._metadata_object = None
+        self._breadcrumb = None
+        self._metadata = None
         self.discriminator = None
 
-        self.breadcrumbs = breadcrumbs
-        self.metadata_object = metadata_object
+        self.breadcrumb = breadcrumb
+        self.metadata = metadata
 
     @property
-    def breadcrumbs(self):
-        """Gets the breadcrumbs of this Metadata.  # noqa: E501
+    def breadcrumb(self):
+        """Gets the breadcrumb of this Metadata.  # noqa: E501
 
         An array of strings describing a path into the schema. For example: A value of [] refers to the entire schema, or stream A value of [\"properties\", \"<FIELD_NAME>\"] refers to the properties.<FIELD_NAME> portion of the schema. For example: [\"properties\", \"id\"] would refer to a field named `id`   # noqa: E501
 
-        :return: The breadcrumbs of this Metadata.  # noqa: E501
+        :return: The breadcrumb of this Metadata.  # noqa: E501
         :rtype: list[str]
         """
-        return self._breadcrumbs
+        return self._breadcrumb
 
-    @breadcrumbs.setter
-    def breadcrumbs(self, breadcrumbs):
-        """Sets the breadcrumbs of this Metadata.
+    @breadcrumb.setter
+    def breadcrumb(self, breadcrumb):
+        """Sets the breadcrumb of this Metadata.
 
         An array of strings describing a path into the schema. For example: A value of [] refers to the entire schema, or stream A value of [\"properties\", \"<FIELD_NAME>\"] refers to the properties.<FIELD_NAME> portion of the schema. For example: [\"properties\", \"id\"] would refer to a field named `id`   # noqa: E501
 
-        :param breadcrumbs: The breadcrumbs of this Metadata.  # noqa: E501
+        :param breadcrumb: The breadcrumb of this Metadata.  # noqa: E501
         :type: list[str]
         """
-        if self.local_vars_configuration.client_side_validation and breadcrumbs is None:  # noqa: E501
-            raise ValueError("Invalid value for `breadcrumbs`, must not be `None`")  # noqa: E501
+        if self.local_vars_configuration.client_side_validation and breadcrumb is None:  # noqa: E501
+            raise ValueError("Invalid value for `breadcrumb`, must not be `None`")  # noqa: E501
 
-        self._breadcrumbs = breadcrumbs
+        self._breadcrumb = breadcrumb
 
     @property
-    def metadata_object(self):
-        """Gets the metadata_object of this Metadata.  # noqa: E501
+    def metadata(self):
+        """Gets the metadata of this Metadata.  # noqa: E501
 
 
-        :return: The metadata_object of this Metadata.  # noqa: E501
+        :return: The metadata of this Metadata.  # noqa: E501
         :rtype: MetadataObject
         """
-        return self._metadata_object
+        return self._metadata
 
-    @metadata_object.setter
-    def metadata_object(self, metadata_object):
-        """Sets the metadata_object of this Metadata.
+    @metadata.setter
+    def metadata(self, metadata):
+        """Sets the metadata of this Metadata.
 
 
-        :param metadata_object: The metadata_object of this Metadata.  # noqa: E501
+        :param metadata: The metadata of this Metadata.  # noqa: E501
         :type: MetadataObject
         """
-        if self.local_vars_configuration.client_side_validation and metadata_object is None:  # noqa: E501
-            raise ValueError("Invalid value for `metadata_object`, must not be `None`")  # noqa: E501
+        if self.local_vars_configuration.client_side_validation and metadata is None:  # noqa: E501
+            raise ValueError("Invalid value for `metadata`, must not be `None`")  # noqa: E501
 
-        self._metadata_object = metadata_object
+        self._metadata = metadata
 
     def to_dict(self):
         """Returns the model properties as a dict"""
diff --git a/stitch_connect_client/models/stream.py b/stitch_connect_client/models/stream.py
@@ -37,7 +37,7 @@ class Stream(object):
         'selected': 'bool',
         'stream_name': 'str',
         'tap_stream_id': 'str',
-        'metadata': 'StreamLevelMetadata'
+        'metadata': 'list[StreamLevelMetadata]'
     }
 
     attribute_map = {
@@ -170,7 +170,7 @@ def metadata(self):
 
 
         :return: The metadata of this Stream.  # noqa: E501
-        :rtype: StreamLevelMetadata
+        :rtype: list[StreamLevelMetadata]
         """
         return self._metadata
 
@@ -180,7 +180,7 @@ def metadata(self, metadata):
 
 
         :param metadata: The metadata of this Stream.  # noqa: E501
-        :type: StreamLevelMetadata
+        :type: list[StreamLevelMetadata]
         """
 
         self._metadata = metadata
diff --git a/stitch_connect_client/models/streams_update.py b/stitch_connect_client/models/streams_update.py
diff --git a/test/test_streams_update.py b/test/test_streams_update.py

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`from setuptools import setup, find_packages # noqa: H301`
`14`	`14`
`15`	`15`	`NAME = "stitch-connect-client"`
`16`		`-VERSION = "0.1.2"`
	`16`	`+VERSION = "0.1.3"`
`17`	`17`	`# To install the library, run the following`
`18`	`18`	`#`
`19`	`19`	`# python setup.py install`