Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 33 additions & 9 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,23 @@ docs/ConnectionHealthResponse.md
docs/ConnectionInfo.md
docs/ConnectionRefreshResult.md
docs/ConnectionSchemaError.md
docs/ConnectionTypeDetail.md
docs/ConnectionTypeSummary.md
docs/ConnectionTypesApi.md
docs/ConnectionsApi.md
docs/CreateConnectionRequest.md
docs/CreateConnectionResponse.md
docs/CreateDatasetRequest.md
docs/CreateDatasetResponse.md
docs/CreateIndexRequest.md
docs/CreateSavedQueryRequest.md
docs/CreateSecretRequest.md
docs/CreateSecretResponse.md
docs/CreateWorkspaceRequest.md
docs/CreateWorkspaceResponse.md
docs/DatasetSource.md
docs/DatasetSummary.md
docs/DatasetVersionSummary.md
docs/DatasetsApi.md
docs/DiscoveryStatus.md
docs/Error.md
Expand All @@ -39,12 +44,18 @@ docs/GetConnectionResponse.md
docs/GetDatasetResponse.md
docs/GetResultResponse.md
docs/GetSecretResponse.md
docs/IndexInfoResponse.md
docs/IndexStatus.md
docs/IndexesApi.md
docs/InformationSchemaApi.md
docs/InformationSchemaResponse.md
docs/InlineData.md
docs/InlineDatasetSource.md
docs/ListConnectionTypesResponse.md
docs/ListConnectionsResponse.md
docs/ListDatasetVersionsResponse.md
docs/ListDatasetsResponse.md
docs/ListIndexesResponse.md
docs/ListQueryRunsResponse.md
docs/ListResultsResponse.md
docs/ListSavedQueriesResponse.md
Expand Down Expand Up @@ -91,8 +102,10 @@ docs/WorkspaceListItem.md
docs/WorkspacesApi.md
hotdata/__init__.py
hotdata/api/__init__.py
hotdata/api/connection_types_api.py
hotdata/api/connections_api.py
hotdata/api/datasets_api.py
hotdata/api/indexes_api.py
hotdata/api/information_schema_api.py
hotdata/api/query_api.py
hotdata/api/query_runs_api.py
Expand Down Expand Up @@ -125,29 +138,38 @@ hotdata/models/connection_health_response.py
hotdata/models/connection_info.py
hotdata/models/connection_refresh_result.py
hotdata/models/connection_schema_error.py
hotdata/models/connection_type_detail.py
hotdata/models/connection_type_summary.py
hotdata/models/create_connection_request.py
hotdata/models/create_connection_response.py
hotdata/models/create_dataset_request.py
hotdata/models/create_dataset_response.py
hotdata/models/create_index_request.py
hotdata/models/create_saved_query_request.py
hotdata/models/create_secret_request.py
hotdata/models/create_secret_response.py
hotdata/models/create_workspace_request.py
hotdata/models/create_workspace_response.py
hotdata/models/dataset_source.py
hotdata/models/dataset_summary.py
hotdata/models/dataset_version_summary.py
hotdata/models/discovery_status.py
hotdata/models/error.py
hotdata/models/execute_saved_query_request.py
hotdata/models/get_connection_response.py
hotdata/models/get_dataset_response.py
hotdata/models/get_result_response.py
hotdata/models/get_secret_response.py
hotdata/models/index_info_response.py
hotdata/models/index_status.py
hotdata/models/information_schema_response.py
hotdata/models/inline_data.py
hotdata/models/inline_dataset_source.py
hotdata/models/list_connection_types_response.py
hotdata/models/list_connections_response.py
hotdata/models/list_dataset_versions_response.py
hotdata/models/list_datasets_response.py
hotdata/models/list_indexes_response.py
hotdata/models/list_query_runs_response.py
hotdata/models/list_results_response.py
hotdata/models/list_saved_queries_response.py
Expand Down Expand Up @@ -192,13 +214,15 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_boolean_profile_detail.py
test/test_categorical_profile_detail.py
test/test_create_workspace_response.py
test/test_inline_dataset_source.py
test/test_list_workspaces_response.py
test/test_numeric_profile_detail.py
test/test_temporal_profile_detail.py
test/test_text_profile_detail.py
test/test_upload_dataset_source.py
test/test_connection_type_detail.py
test/test_connection_type_summary.py
test/test_connection_types_api.py
test/test_create_index_request.py
test/test_dataset_version_summary.py
test/test_index_info_response.py
test/test_index_status.py
test/test_indexes_api.py
test/test_list_connection_types_response.py
test/test_list_dataset_versions_response.py
test/test_list_indexes_response.py
tox.ini
32 changes: 32 additions & 0 deletions docs/ConnectionTypeDetail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ConnectionTypeDetail


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auth** | **object** | | [optional]
**config_schema** | **object** | | [optional]
**label** | **str** | |
**name** | **str** | |

## Example

```python
from hotdata.models.connection_type_detail import ConnectionTypeDetail

# TODO update the JSON string below
json = "{}"
# create an instance of ConnectionTypeDetail from a JSON string
connection_type_detail_instance = ConnectionTypeDetail.from_json(json)
# print the JSON string representation of the object
print(ConnectionTypeDetail.to_json())

# convert the object into a dict
connection_type_detail_dict = connection_type_detail_instance.to_dict()
# create an instance of ConnectionTypeDetail from a dict
connection_type_detail_from_dict = ConnectionTypeDetail.from_dict(connection_type_detail_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)


30 changes: 30 additions & 0 deletions docs/ConnectionTypeSummary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ConnectionTypeSummary


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **str** | |
**name** | **str** | |

## Example

```python
from hotdata.models.connection_type_summary import ConnectionTypeSummary

# TODO update the JSON string below
json = "{}"
# create an instance of ConnectionTypeSummary from a JSON string
connection_type_summary_instance = ConnectionTypeSummary.from_json(json)
# print the JSON string representation of the object
print(ConnectionTypeSummary.to_json())

# convert the object into a dict
connection_type_summary_dict = connection_type_summary_instance.to_dict()
# create an instance of ConnectionTypeSummary from a dict
connection_type_summary_from_dict = ConnectionTypeSummary.from_dict(connection_type_summary_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)


163 changes: 163 additions & 0 deletions docs/ConnectionTypesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# hotdata.ConnectionTypesApi

All URIs are relative to *https://app.hotdata.dev*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_connection_type**](ConnectionTypesApi.md#get_connection_type) | **GET** /v1/connection-types/{name} | Get connection type details
[**list_connection_types**](ConnectionTypesApi.md#list_connection_types) | **GET** /v1/connection-types | List connection types


# **get_connection_type**
> ConnectionTypeDetail get_connection_type(name)

Get connection type details

Get configuration schema and authentication requirements for a specific connection type.

### Example

* Bearer Authentication (BearerAuth):

```python
import hotdata
from hotdata.models.connection_type_detail import ConnectionTypeDetail
from hotdata.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.hotdata.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = hotdata.Configuration(
host = "https://app.hotdata.dev"
)

# 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 Bearer authorization: BearerAuth
configuration = hotdata.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hotdata.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hotdata.ConnectionTypesApi(api_client)
name = 'name_example' # str | Connection type name (e.g. postgres, mysql, snowflake)

try:
# Get connection type details
api_response = api_instance.get_connection_type(name)
print("The response of ConnectionTypesApi->get_connection_type:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ConnectionTypesApi->get_connection_type: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| Connection type name (e.g. postgres, mysql, snowflake) |

### Return type

[**ConnectionTypeDetail**](ConnectionTypeDetail.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Connection type details | - |
**404** | Unknown connection type | - |

[[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)

# **list_connection_types**
> ListConnectionTypesResponse list_connection_types()

List connection types

List all available connection types, including native sources and FlightDLT services.

### Example

* Bearer Authentication (BearerAuth):

```python
import hotdata
from hotdata.models.list_connection_types_response import ListConnectionTypesResponse
from hotdata.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.hotdata.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = hotdata.Configuration(
host = "https://app.hotdata.dev"
)

# 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 Bearer authorization: BearerAuth
configuration = hotdata.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hotdata.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hotdata.ConnectionTypesApi(api_client)

try:
# List connection types
api_response = api_instance.list_connection_types()
print("The response of ConnectionTypesApi->list_connection_types:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ConnectionTypesApi->list_connection_types: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListConnectionTypesResponse**](ListConnectionTypesResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Available connection types | - |

[[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)

35 changes: 35 additions & 0 deletions docs/CreateIndexRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CreateIndexRequest

Request body for POST .../indexes

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**index_name** | **str** | |
**index_type** | **str** | Index type: \"sorted\" (default), \"bm25\", or \"vector\" | [optional]
**metric** | **str** | Distance metric for vector indexes: \"l2\" (default), \"cosine\", or \"dot\". Only relevant when index_type = \"vector\". | [optional]
**sort_columns** | **List[str]** | | [optional]
**text_columns** | **List[str]** | Text columns for BM25 indexes | [optional]
**vector_columns** | **List[str]** | Vector column for vector indexes (exactly one entry required) | [optional]

## Example

```python
from hotdata.models.create_index_request import CreateIndexRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreateIndexRequest from a JSON string
create_index_request_instance = CreateIndexRequest.from_json(json)
# print the JSON string representation of the object
print(CreateIndexRequest.to_json())

# convert the object into a dict
create_index_request_dict = create_index_request_instance.to_dict()
# create an instance of CreateIndexRequest from a dict
create_index_request_from_dict = CreateIndexRequest.from_dict(create_index_request_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)


2 changes: 2 additions & 0 deletions docs/DatasetSummary.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Name | Type | Description | Notes
**created_at** | **datetime** | |
**id** | **str** | |
**label** | **str** | |
**latest_version** | **int** | |
**pinned_version** | **int** | | [optional]
**table_name** | **str** | |
**updated_at** | **datetime** | |

Expand Down
Loading
Loading