From 12d6cd609cae895bec9aa37246aeac94d4b40b2f Mon Sep 17 00:00:00 2001 From: Tadej Volgemut Date: Mon, 2 Sep 2024 13:03:37 +0200 Subject: [PATCH 1/5] Create pushData.py --- examples/pushData/pushData.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 examples/pushData/pushData.py diff --git a/examples/pushData/pushData.py b/examples/pushData/pushData.py new file mode 100644 index 0000000..1d5fcaf --- /dev/null +++ b/examples/pushData/pushData.py @@ -0,0 +1,18 @@ +import databox +from databox.rest import ApiException +from pprint import pprint + +configuration = databox.Configuration( + host = "https://push.databox.com", + username = "00d0a69a8be14b70a7e5c8de62b3b57d", + password = "" +) + +with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client: + api_instance = databox.DefaultApi(api_client) + push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }] + try: + api_instance.data_post(push_data=push_data) + except Exception as e: + print("Exception: %s\n" % e) + \ No newline at end of file From 37be80ebf7d8bc947ee67a9b7f2a46b45390e4ae Mon Sep 17 00:00:00 2001 From: Tadej Volgemut Date: Mon, 2 Sep 2024 13:14:17 +0200 Subject: [PATCH 2/5] Update pushData.py --- examples/pushData/pushData.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/pushData/pushData.py b/examples/pushData/pushData.py index 1d5fcaf..202e3f5 100644 --- a/examples/pushData/pushData.py +++ b/examples/pushData/pushData.py @@ -4,7 +4,7 @@ configuration = databox.Configuration( host = "https://push.databox.com", - username = "00d0a69a8be14b70a7e5c8de62b3b57d", + username = "", password = "" ) From 71fdb82a2e9642e19561edc2c3d2c6e086ea510d Mon Sep 17 00:00:00 2001 From: Tadej Volgemut Date: Tue, 3 Sep 2024 11:30:55 +0200 Subject: [PATCH 3/5] CR improvements --- examples/pushData/pushData.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/examples/pushData/pushData.py b/examples/pushData/pushData.py index 202e3f5..8bb4107 100644 --- a/examples/pushData/pushData.py +++ b/examples/pushData/pushData.py @@ -2,17 +2,25 @@ from databox.rest import ApiException from pprint import pprint +# Configuration setup for the Databox API client +# The API token is used as the username for authentication +# It's recommended to store your API token securely, e.g., in an environment variable configuration = databox.Configuration( host = "https://push.databox.com", username = "", password = "" -) - +) with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client: api_instance = databox.DefaultApi(api_client) + push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }] + try: api_instance.data_post(push_data=push_data) + except ApiException as e: + # Handle exceptions that occur during the API call, such as invalid data or authentication issues + pprint("API Exception occurred: %s\n" % e) except Exception as e: - print("Exception: %s\n" % e) + # Handle any other unexpected exceptions + pprint("An unexpected error occurred: %s\n" % e) \ No newline at end of file From 4001aeace3fe46b2d62746a084b43f80407c4bdc Mon Sep 17 00:00:00 2001 From: Tadej Volgemut Date: Tue, 10 Sep 2024 05:44:08 +0200 Subject: [PATCH 4/5] update docs --- README.md | 87 ++----- examples/pushData/pushData.py | 6 +- src/README.md | 87 ++----- src/docs/ApiResponse.md | 30 --- src/docs/DefaultApi.md | 441 ---------------------------------- src/docs/PushData.md | 35 --- src/docs/PushDataAttribute.md | 30 --- src/docs/State.md | 11 - 8 files changed, 47 insertions(+), 680 deletions(-) delete mode 100644 src/docs/ApiResponse.md delete mode 100644 src/docs/DefaultApi.md delete mode 100644 src/docs/PushData.md delete mode 100644 src/docs/PushDataAttribute.md delete mode 100644 src/docs/State.md diff --git a/README.md b/README.md index 409e255..65bf358 100644 --- a/README.md +++ b/README.md @@ -45,81 +45,36 @@ import databox Execute `pytest` to run the tests. -## Getting Started +## Basic example Please follow the [installation procedure](#installation--usage) and then run the following: ```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth +# Configuration setup for the Databox API client +# The API token is used as the username for authentication +# It's recommended to store your API token securely, e.g., in an environment variable configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) + host = "https://push.databox.com", + username = "", + password = "" +) +# It's crucial to specify the correct Accept header for the API request +with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client: + api_instance = databox.DefaultApi(api_client) -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) + # Define the data to be pushed to the Databox Push API# Prepare the data you want to push to Databox + # The 'key' should match a metric in your Databox account, 'value' is the data point, 'unit' is optional, and 'date' is the timestamp of the data point + push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }] try: - api_instance.data_delete() + api_instance.data_post(push_data=push_data) except ApiException as e: - print("Exception when calling DefaultApi->data_delete: %s\n" % e) - + # Handle exceptions that occur during the API call, such as invalid data or authentication issues + pprint("API Exception occurred: %s\n" % e) + except Exception as e: + # Handle any other unexpected exceptions + pprint("An unexpected error occurred: %s\n" % e) + ``` - -## Documentation for API Endpoints - -All URIs are relative to *https://push.databox.com* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DefaultApi* | [**data_delete**](docs/DefaultApi.md#data_delete) | **DELETE** /data | -*DefaultApi* | [**data_metric_key_delete**](docs/DefaultApi.md#data_metric_key_delete) | **DELETE** /data/{metricKey} | -*DefaultApi* | [**data_post**](docs/DefaultApi.md#data_post) | **POST** /data | -*DefaultApi* | [**metrickeys_get**](docs/DefaultApi.md#metrickeys_get) | **GET** /metrickeys | -*DefaultApi* | [**metrickeys_post**](docs/DefaultApi.md#metrickeys_post) | **POST** /metrickeys | -*DefaultApi* | [**ping_get**](docs/DefaultApi.md#ping_get) | **GET** /ping | - - -## Documentation For Models - - - [ApiResponse](docs/ApiResponse.md) - - [PushData](docs/PushData.md) - - [PushDataAttribute](docs/PushDataAttribute.md) - - [State](docs/State.md) - - - -## Documentation For Authorization - - -Authentication schemes defined for the API: - -### basicAuth - -- **Type**: HTTP basic authentication - - -## Author - - - - diff --git a/examples/pushData/pushData.py b/examples/pushData/pushData.py index 8bb4107..17f7c2e 100644 --- a/examples/pushData/pushData.py +++ b/examples/pushData/pushData.py @@ -10,9 +10,13 @@ username = "", password = "" ) + +# It's crucial to specify the correct Accept header for the API request with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client: api_instance = databox.DefaultApi(api_client) - + + # Define the data to be pushed to the Databox Push API# Prepare the data you want to push to Databox + # The 'key' should match a metric in your Databox account, 'value' is the data point, 'unit' is optional, and 'date' is the timestamp of the data point push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }] try: diff --git a/src/README.md b/src/README.md index 409e255..65bf358 100644 --- a/src/README.md +++ b/src/README.md @@ -45,81 +45,36 @@ import databox Execute `pytest` to run the tests. -## Getting Started +## Basic example Please follow the [installation procedure](#installation--usage) and then run the following: ```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth +# Configuration setup for the Databox API client +# The API token is used as the username for authentication +# It's recommended to store your API token securely, e.g., in an environment variable configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) + host = "https://push.databox.com", + username = "", + password = "" +) +# It's crucial to specify the correct Accept header for the API request +with databox.ApiClient(configuration, "Accept", "application/vnd.databox.v2+json",) as api_client: + api_instance = databox.DefaultApi(api_client) -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) + # Define the data to be pushed to the Databox Push API# Prepare the data you want to push to Databox + # The 'key' should match a metric in your Databox account, 'value' is the data point, 'unit' is optional, and 'date' is the timestamp of the data point + push_data = [{"key": "sales2", "value": 100, "unit": "USD", "date": "2021-01-01T00:00:00Z" }] try: - api_instance.data_delete() + api_instance.data_post(push_data=push_data) except ApiException as e: - print("Exception when calling DefaultApi->data_delete: %s\n" % e) - + # Handle exceptions that occur during the API call, such as invalid data or authentication issues + pprint("API Exception occurred: %s\n" % e) + except Exception as e: + # Handle any other unexpected exceptions + pprint("An unexpected error occurred: %s\n" % e) + ``` - -## Documentation for API Endpoints - -All URIs are relative to *https://push.databox.com* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DefaultApi* | [**data_delete**](docs/DefaultApi.md#data_delete) | **DELETE** /data | -*DefaultApi* | [**data_metric_key_delete**](docs/DefaultApi.md#data_metric_key_delete) | **DELETE** /data/{metricKey} | -*DefaultApi* | [**data_post**](docs/DefaultApi.md#data_post) | **POST** /data | -*DefaultApi* | [**metrickeys_get**](docs/DefaultApi.md#metrickeys_get) | **GET** /metrickeys | -*DefaultApi* | [**metrickeys_post**](docs/DefaultApi.md#metrickeys_post) | **POST** /metrickeys | -*DefaultApi* | [**ping_get**](docs/DefaultApi.md#ping_get) | **GET** /ping | - - -## Documentation For Models - - - [ApiResponse](docs/ApiResponse.md) - - [PushData](docs/PushData.md) - - [PushDataAttribute](docs/PushDataAttribute.md) - - [State](docs/State.md) - - - -## Documentation For Authorization - - -Authentication schemes defined for the API: - -### basicAuth - -- **Type**: HTTP basic authentication - - -## Author - - - - diff --git a/src/docs/ApiResponse.md b/src/docs/ApiResponse.md deleted file mode 100644 index 5daba95..0000000 --- a/src/docs/ApiResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# ApiResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **str** | | [optional] -**message** | **str** | | [optional] - -## Example - -```python -from databox.models.api_response import ApiResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of ApiResponse from a JSON string -api_response_instance = ApiResponse.from_json(json) -# print the JSON string representation of the object -print(ApiResponse.to_json()) - -# convert the object into a dict -api_response_dict = api_response_instance.to_dict() -# create an instance of ApiResponse from a dict -api_response_from_dict = ApiResponse.from_dict(api_response_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/src/docs/DefaultApi.md b/src/docs/DefaultApi.md deleted file mode 100644 index b863966..0000000 --- a/src/docs/DefaultApi.md +++ /dev/null @@ -1,441 +0,0 @@ -# databox.DefaultApi - -All URIs are relative to *https://push.databox.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**data_delete**](DefaultApi.md#data_delete) | **DELETE** /data | -[**data_metric_key_delete**](DefaultApi.md#data_metric_key_delete) | **DELETE** /data/{metricKey} | -[**data_post**](DefaultApi.md#data_post) | **POST** /data | -[**metrickeys_get**](DefaultApi.md#metrickeys_get) | **GET** /metrickeys | -[**metrickeys_post**](DefaultApi.md#metrickeys_post) | **POST** /metrickeys | -[**ping_get**](DefaultApi.md#ping_get) | **GET** /ping | - - -# **data_delete** -> data_delete() - - - -### Example - -* Basic Authentication (basicAuth): - -```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) - - try: - api_instance.data_delete() - except Exception as e: - print("Exception when calling DefaultApi->data_delete: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - -# **data_metric_key_delete** -> data_metric_key_delete(metric_key) - - - -### Example - -* Basic Authentication (basicAuth): - -```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) - metric_key = 'metric_key_example' # str | - - try: - api_instance.data_metric_key_delete(metric_key) - except Exception as e: - print("Exception when calling DefaultApi->data_metric_key_delete: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metric_key** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - -# **data_post** -> data_post(push_data=push_data) - - - -### Example - -* Basic Authentication (basicAuth): - -```python -import databox -from databox.models.push_data import PushData -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) - push_data = [databox.PushData()] # List[PushData] | (optional) - - try: - api_instance.data_post(push_data=push_data) - except Exception as e: - print("Exception when calling DefaultApi->data_post: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **push_data** | [**List[PushData]**](PushData.md)| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.databox.v2+json - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - -# **metrickeys_get** -> metrickeys_get() - - - -### Example - -* Basic Authentication (basicAuth): - -```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) - - try: - api_instance.metrickeys_get() - except Exception as e: - print("Exception when calling DefaultApi->metrickeys_get: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - -# **metrickeys_post** -> metrickeys_post(body=body) - - - -### Example - -* Basic Authentication (basicAuth): - -```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) - body = None # object | (optional) - - try: - api_instance.metrickeys_post(body=body) - except Exception as e: - print("Exception when calling DefaultApi->metrickeys_post: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | **object**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: application/json, application/vnd.databox.v2+json - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - -# **ping_get** -> ping_get() - - - -### Example - -* Basic Authentication (basicAuth): - -```python -import databox -from databox.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://push.databox.com -# See configuration.py for a list of all supported configuration parameters. -configuration = databox.Configuration( - host = "https://push.databox.com" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basicAuth -configuration = databox.Configuration( - username = os.environ["USERNAME"], - password = os.environ["PASSWORD"] -) - -# Enter a context with an instance of the API client -with databox.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = databox.DefaultApi(api_client) - - try: - api_instance.ping_get() - except Exception as e: - print("Exception when calling DefaultApi->ping_get: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - diff --git a/src/docs/PushData.md b/src/docs/PushData.md deleted file mode 100644 index 50cc21b..0000000 --- a/src/docs/PushData.md +++ /dev/null @@ -1,35 +0,0 @@ -# PushData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attributes** | [**List[PushDataAttribute]**](PushDataAttribute.md) | | [optional] -**var_date** | **str** | | [optional] -**key** | **str** | | [optional] -**period_from** | **str** | | [optional] -**period_to** | **str** | | [optional] -**unit** | **str** | | [optional] -**value** | **float** | | [optional] - -## Example - -```python -from databox.models.push_data import PushData - -# TODO update the JSON string below -json = "{}" -# create an instance of PushData from a JSON string -push_data_instance = PushData.from_json(json) -# print the JSON string representation of the object -print(PushData.to_json()) - -# convert the object into a dict -push_data_dict = push_data_instance.to_dict() -# create an instance of PushData from a dict -push_data_from_dict = PushData.from_dict(push_data_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/src/docs/PushDataAttribute.md b/src/docs/PushDataAttribute.md deleted file mode 100644 index 7200a64..0000000 --- a/src/docs/PushDataAttribute.md +++ /dev/null @@ -1,30 +0,0 @@ -# PushDataAttribute - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **str** | | [optional] -**value** | **str** | | [optional] - -## Example - -```python -from databox.models.push_data_attribute import PushDataAttribute - -# TODO update the JSON string below -json = "{}" -# create an instance of PushDataAttribute from a JSON string -push_data_attribute_instance = PushDataAttribute.from_json(json) -# print the JSON string representation of the object -print(PushDataAttribute.to_json()) - -# convert the object into a dict -push_data_attribute_dict = push_data_attribute_instance.to_dict() -# create an instance of PushDataAttribute from a dict -push_data_attribute_from_dict = PushDataAttribute.from_dict(push_data_attribute_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/src/docs/State.md b/src/docs/State.md deleted file mode 100644 index 49b0f6f..0000000 --- a/src/docs/State.md +++ /dev/null @@ -1,11 +0,0 @@ -# State - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - From 06e64de5fe9fc84c17f801cc3f70d09cea7f5618 Mon Sep 17 00:00:00 2001 From: alekseimi Date: Thu, 19 Sep 2024 15:22:46 +0200 Subject: [PATCH 5/5] Changed example file name from camelcase to snakecase. --- examples/{pushData/pushData.py => push_data.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename examples/{pushData/pushData.py => push_data.py} (100%) diff --git a/examples/pushData/pushData.py b/examples/push_data.py similarity index 100% rename from examples/pushData/pushData.py rename to examples/push_data.py