Skip to content

Commit 8440ec9

Browse files
eddietejedaeddietejeda
authored
Merge pull request #15 from hotdata-dev/openapi-update-23157963104
chore: regenerate client from updated OpenAPI spec
2 parents f913a13 + 5946ec3 commit 8440ec9

16 files changed

Lines changed: 1336 additions & 9 deletions

‎.openapi-generator/FILES‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ docs/ConnectionHealthResponse.md
1919
docs/ConnectionInfo.md
2020
docs/ConnectionRefreshResult.md
2121
docs/ConnectionSchemaError.md
22+
docs/ConnectionTypeDetail.md
23+
docs/ConnectionTypeSummary.md
24+
docs/ConnectionTypesApi.md
2225
docs/ConnectionsApi.md
2326
docs/CreateConnectionRequest.md
2427
docs/CreateConnectionResponse.md
@@ -43,6 +46,7 @@ docs/InformationSchemaApi.md
4346
docs/InformationSchemaResponse.md
4447
docs/InlineData.md
4548
docs/InlineDatasetSource.md
49+
docs/ListConnectionTypesResponse.md
4650
docs/ListConnectionsResponse.md
4751
docs/ListDatasetsResponse.md
4852
docs/ListQueryRunsResponse.md
@@ -91,6 +95,7 @@ docs/WorkspaceListItem.md
9195
docs/WorkspacesApi.md
9296
hotdata/__init__.py
9397
hotdata/api/__init__.py
98+
hotdata/api/connection_types_api.py
9499
hotdata/api/connections_api.py
95100
hotdata/api/datasets_api.py
96101
hotdata/api/information_schema_api.py
@@ -125,6 +130,8 @@ hotdata/models/connection_health_response.py
125130
hotdata/models/connection_info.py
126131
hotdata/models/connection_refresh_result.py
127132
hotdata/models/connection_schema_error.py
133+
hotdata/models/connection_type_detail.py
134+
hotdata/models/connection_type_summary.py
128135
hotdata/models/create_connection_request.py
129136
hotdata/models/create_connection_response.py
130137
hotdata/models/create_dataset_request.py
@@ -146,6 +153,7 @@ hotdata/models/get_secret_response.py
146153
hotdata/models/information_schema_response.py
147154
hotdata/models/inline_data.py
148155
hotdata/models/inline_dataset_source.py
156+
hotdata/models/list_connection_types_response.py
149157
hotdata/models/list_connections_response.py
150158
hotdata/models/list_datasets_response.py
151159
hotdata/models/list_query_runs_response.py
@@ -192,13 +200,8 @@ setup.cfg
192200
setup.py
193201
test-requirements.txt
194202
test/__init__.py
195-
test/test_boolean_profile_detail.py
196-
test/test_categorical_profile_detail.py
197-
test/test_create_workspace_response.py
198-
test/test_inline_dataset_source.py
199-
test/test_list_workspaces_response.py
200-
test/test_numeric_profile_detail.py
201-
test/test_temporal_profile_detail.py
202-
test/test_text_profile_detail.py
203-
test/test_upload_dataset_source.py
203+
test/test_connection_type_detail.py
204+
test/test_connection_type_summary.py
205+
test/test_connection_types_api.py
206+
test/test_list_connection_types_response.py
204207
tox.ini

‎docs/ConnectionTypeDetail.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# ConnectionTypeDetail
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**auth** | **object** | | [optional]
9+
**config_schema** | **object** | | [optional]
10+
**label** | **str** | |
11+
**name** | **str** | |
12+
13+
## Example
14+
15+
```python
16+
from hotdata.models.connection_type_detail import ConnectionTypeDetail
17+
18+
# TODO update the JSON string below
19+
json = "{}"
20+
# create an instance of ConnectionTypeDetail from a JSON string
21+
connection_type_detail_instance = ConnectionTypeDetail.from_json(json)
22+
# print the JSON string representation of the object
23+
print(ConnectionTypeDetail.to_json())
24+
25+
# convert the object into a dict
26+
connection_type_detail_dict = connection_type_detail_instance.to_dict()
27+
# create an instance of ConnectionTypeDetail from a dict
28+
connection_type_detail_from_dict = ConnectionTypeDetail.from_dict(connection_type_detail_dict)
29+
```
30+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31+
32+

‎docs/ConnectionTypeSummary.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# ConnectionTypeSummary
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**label** | **str** | |
9+
**name** | **str** | |
10+
11+
## Example
12+
13+
```python
14+
from hotdata.models.connection_type_summary import ConnectionTypeSummary
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of ConnectionTypeSummary from a JSON string
19+
connection_type_summary_instance = ConnectionTypeSummary.from_json(json)
20+
# print the JSON string representation of the object
21+
print(ConnectionTypeSummary.to_json())
22+
23+
# convert the object into a dict
24+
connection_type_summary_dict = connection_type_summary_instance.to_dict()
25+
# create an instance of ConnectionTypeSummary from a dict
26+
connection_type_summary_from_dict = ConnectionTypeSummary.from_dict(connection_type_summary_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/ConnectionTypesApi.md‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# hotdata.ConnectionTypesApi
2+
3+
All URIs are relative to *https://app.hotdata.dev*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**get_connection_type**](ConnectionTypesApi.md#get_connection_type) | **GET** /v1/connection-types/{name} | Get connection type details
8+
[**list_connection_types**](ConnectionTypesApi.md#list_connection_types) | **GET** /v1/connection-types | List connection types
9+
10+
11+
# **get_connection_type**
12+
> ConnectionTypeDetail get_connection_type(name)
13+
14+
Get connection type details
15+
16+
Get configuration schema and authentication requirements for a specific connection type.
17+
18+
### Example
19+
20+
* Bearer Authentication (BearerAuth):
21+
22+
```python
23+
import hotdata
24+
from hotdata.models.connection_type_detail import ConnectionTypeDetail
25+
from hotdata.rest import ApiException
26+
from pprint import pprint
27+
28+
# Defining the host is optional and defaults to https://app.hotdata.dev
29+
# See configuration.py for a list of all supported configuration parameters.
30+
configuration = hotdata.Configuration(
31+
host = "https://app.hotdata.dev"
32+
)
33+
34+
# The client must configure the authentication and authorization parameters
35+
# in accordance with the API server security policy.
36+
# Examples for each auth method are provided below, use the example that
37+
# satisfies your auth use case.
38+
39+
# Configure Bearer authorization: BearerAuth
40+
configuration = hotdata.Configuration(
41+
access_token = os.environ["BEARER_TOKEN"]
42+
)
43+
44+
# Enter a context with an instance of the API client
45+
with hotdata.ApiClient(configuration) as api_client:
46+
# Create an instance of the API class
47+
api_instance = hotdata.ConnectionTypesApi(api_client)
48+
name = 'name_example' # str | Connection type name (e.g. postgres, mysql, snowflake)
49+
50+
try:
51+
# Get connection type details
52+
api_response = api_instance.get_connection_type(name)
53+
print("The response of ConnectionTypesApi->get_connection_type:\n")
54+
pprint(api_response)
55+
except Exception as e:
56+
print("Exception when calling ConnectionTypesApi->get_connection_type: %s\n" % e)
57+
```
58+
59+
60+
61+
### Parameters
62+
63+
64+
Name | Type | Description | Notes
65+
------------- | ------------- | ------------- | -------------
66+
**name** | **str**| Connection type name (e.g. postgres, mysql, snowflake) |
67+
68+
### Return type
69+
70+
[**ConnectionTypeDetail**](ConnectionTypeDetail.md)
71+
72+
### Authorization
73+
74+
[BearerAuth](../README.md#BearerAuth)
75+
76+
### HTTP request headers
77+
78+
- **Content-Type**: Not defined
79+
- **Accept**: application/json
80+
81+
### HTTP response details
82+
83+
| Status code | Description | Response headers |
84+
|-------------|-------------|------------------|
85+
**200** | Connection type details | - |
86+
**404** | Unknown connection type | - |
87+
88+
[[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)
89+
90+
# **list_connection_types**
91+
> ListConnectionTypesResponse list_connection_types()
92+
93+
List connection types
94+
95+
List all available connection types, including native sources and FlightDLT services.
96+
97+
### Example
98+
99+
* Bearer Authentication (BearerAuth):
100+
101+
```python
102+
import hotdata
103+
from hotdata.models.list_connection_types_response import ListConnectionTypesResponse
104+
from hotdata.rest import ApiException
105+
from pprint import pprint
106+
107+
# Defining the host is optional and defaults to https://app.hotdata.dev
108+
# See configuration.py for a list of all supported configuration parameters.
109+
configuration = hotdata.Configuration(
110+
host = "https://app.hotdata.dev"
111+
)
112+
113+
# The client must configure the authentication and authorization parameters
114+
# in accordance with the API server security policy.
115+
# Examples for each auth method are provided below, use the example that
116+
# satisfies your auth use case.
117+
118+
# Configure Bearer authorization: BearerAuth
119+
configuration = hotdata.Configuration(
120+
access_token = os.environ["BEARER_TOKEN"]
121+
)
122+
123+
# Enter a context with an instance of the API client
124+
with hotdata.ApiClient(configuration) as api_client:
125+
# Create an instance of the API class
126+
api_instance = hotdata.ConnectionTypesApi(api_client)
127+
128+
try:
129+
# List connection types
130+
api_response = api_instance.list_connection_types()
131+
print("The response of ConnectionTypesApi->list_connection_types:\n")
132+
pprint(api_response)
133+
except Exception as e:
134+
print("Exception when calling ConnectionTypesApi->list_connection_types: %s\n" % e)
135+
```
136+
137+
138+
139+
### Parameters
140+
141+
This endpoint does not need any parameter.
142+
143+
### Return type
144+
145+
[**ListConnectionTypesResponse**](ListConnectionTypesResponse.md)
146+
147+
### Authorization
148+
149+
[BearerAuth](../README.md#BearerAuth)
150+
151+
### HTTP request headers
152+
153+
- **Content-Type**: Not defined
154+
- **Accept**: application/json
155+
156+
### HTTP response details
157+
158+
| Status code | Description | Response headers |
159+
|-------------|-------------|------------------|
160+
**200** | Available connection types | - |
161+
162+
[[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)
163+

‎docs/ListConnectionTypesResponse.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# ListConnectionTypesResponse
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**connection_types** | [**List[ConnectionTypeSummary]**](ConnectionTypeSummary.md) | |
9+
10+
## Example
11+
12+
```python
13+
from hotdata.models.list_connection_types_response import ListConnectionTypesResponse
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of ListConnectionTypesResponse from a JSON string
18+
list_connection_types_response_instance = ListConnectionTypesResponse.from_json(json)
19+
# print the JSON string representation of the object
20+
print(ListConnectionTypesResponse.to_json())
21+
22+
# convert the object into a dict
23+
list_connection_types_response_dict = list_connection_types_response_instance.to_dict()
24+
# create an instance of ListConnectionTypesResponse from a dict
25+
list_connection_types_response_from_dict = ListConnectionTypesResponse.from_dict(list_connection_types_response_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

‎hotdata/__init__.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
# Define package exports
2121
__all__ = [
22+
"ConnectionTypesApi",
2223
"ConnectionsApi",
2324
"DatasetsApi",
2425
"InformationSchemaApi",
@@ -57,6 +58,8 @@
5758
"ConnectionInfo",
5859
"ConnectionRefreshResult",
5960
"ConnectionSchemaError",
61+
"ConnectionTypeDetail",
62+
"ConnectionTypeSummary",
6063
"CreateConnectionRequest",
6164
"CreateConnectionResponse",
6265
"CreateDatasetRequest",
@@ -78,6 +81,7 @@
7881
"InformationSchemaResponse",
7982
"InlineData",
8083
"InlineDatasetSource",
84+
"ListConnectionTypesResponse",
8185
"ListConnectionsResponse",
8286
"ListDatasetsResponse",
8387
"ListQueryRunsResponse",
@@ -119,6 +123,7 @@
119123
]
120124

121125
# import apis into sdk package
126+
from hotdata.api.connection_types_api import ConnectionTypesApi as ConnectionTypesApi
122127
from hotdata.api.connections_api import ConnectionsApi as ConnectionsApi
123128
from hotdata.api.datasets_api import DatasetsApi as DatasetsApi
124129
from hotdata.api.information_schema_api import InformationSchemaApi as InformationSchemaApi
@@ -161,6 +166,8 @@
161166
from hotdata.models.connection_info import ConnectionInfo as ConnectionInfo
162167
from hotdata.models.connection_refresh_result import ConnectionRefreshResult as ConnectionRefreshResult
163168
from hotdata.models.connection_schema_error import ConnectionSchemaError as ConnectionSchemaError
169+
from hotdata.models.connection_type_detail import ConnectionTypeDetail as ConnectionTypeDetail
170+
from hotdata.models.connection_type_summary import ConnectionTypeSummary as ConnectionTypeSummary
164171
from hotdata.models.create_connection_request import CreateConnectionRequest as CreateConnectionRequest
165172
from hotdata.models.create_connection_response import CreateConnectionResponse as CreateConnectionResponse
166173
from hotdata.models.create_dataset_request import CreateDatasetRequest as CreateDatasetRequest
@@ -182,6 +189,7 @@
182189
from hotdata.models.information_schema_response import InformationSchemaResponse as InformationSchemaResponse
183190
from hotdata.models.inline_data import InlineData as InlineData
184191
from hotdata.models.inline_dataset_source import InlineDatasetSource as InlineDatasetSource
192+
from hotdata.models.list_connection_types_response import ListConnectionTypesResponse as ListConnectionTypesResponse
185193
from hotdata.models.list_connections_response import ListConnectionsResponse as ListConnectionsResponse
186194
from hotdata.models.list_datasets_response import ListDatasetsResponse as ListDatasetsResponse
187195
from hotdata.models.list_query_runs_response import ListQueryRunsResponse as ListQueryRunsResponse

‎hotdata/api/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# flake8: noqa
22

33
# import apis into api package
4+
from hotdata.api.connection_types_api import ConnectionTypesApi
45
from hotdata.api.connections_api import ConnectionsApi
56
from hotdata.api.datasets_api import DatasetsApi
67
from hotdata.api.information_schema_api import InformationSchemaApi

0 commit comments

Comments
 (0)