All URIs are relative to http://localhost:8000/api
| Method | HTTP request | Description |
|---|---|---|
| apply_schema_change_for_source | POST /v1/sources/apply_schema_changes | Auto propagate the change on a catalog to a catalog saved in the DB. It will fetch all the connections linked to a source id and apply the provided diff to their catalog. |
| check_connection_to_source | POST /v1/sources/check_connection | Check connection to the source |
| check_connection_to_source_for_update | POST /v1/sources/check_connection_for_update | Check connection for a proposed update to a source |
| clone_source | POST /v1/sources/clone | Clone source |
| create_source | POST /v1/sources/create | Create a source |
| delete_source | POST /v1/sources/delete | Delete a source |
| discover_schema_for_source | POST /v1/sources/discover_schema | Discover the schema catalog of the source |
| get_most_recent_source_actor_catalog | POST /v1/sources/most_recent_source_actor_catalog | Get most recent ActorCatalog for source |
| get_source | POST /v1/sources/get | Get source |
| list_sources_for_workspace | POST /v1/sources/list | List sources for workspace |
| partial_update_source | POST /v1/sources/partial_update | Partially update a source |
| search_sources | POST /v1/sources/search | Search sources |
| update_source | POST /v1/sources/update | Update a source |
| write_discover_catalog_result | POST /v1/sources/write_discover_catalog_result | Should only called from worker, to write result from discover activity back to DB. |
apply_schema_change_for_source(source_auto_propagate_change) Auto propagate the change on a catalog to a catalog saved in the DB. It will fetch all the connections linked to a source id and apply the provided diff to their catalog.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_auto_propagate_change | SourceAutoPropagateChange | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::CheckConnectionRead check_connection_to_source(source_id_request_body) Check connection to the source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_id_request_body | SourceIdRequestBody | [required] |
crate::models::CheckConnectionRead
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::CheckConnectionRead check_connection_to_source_for_update(source_update) Check connection for a proposed update to a source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_update | SourceUpdate | [required] |
crate::models::CheckConnectionRead
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceRead clone_source(source_clone_request_body) Clone source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_clone_request_body | SourceCloneRequestBody | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceRead create_source(source_create) Create a source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_create | SourceCreate | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_source(source_id_request_body) Delete a source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_id_request_body | SourceIdRequestBody | [required] |
(empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceDiscoverSchemaRead discover_schema_for_source(source_discover_schema_request_body) Discover the schema catalog of the source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_discover_schema_request_body | SourceDiscoverSchemaRequestBody | [required] |
crate::models::SourceDiscoverSchemaRead
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ActorCatalogWithUpdatedAt get_most_recent_source_actor_catalog(source_id_request_body) Get most recent ActorCatalog for source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_id_request_body | SourceIdRequestBody | [required] |
crate::models::ActorCatalogWithUpdatedAt
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceRead get_source(source_id_request_body) Get source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_id_request_body | SourceIdRequestBody | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceReadList list_sources_for_workspace(workspace_id_request_body) List sources for workspace
List sources for workspace. Does not return deleted sources.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| workspace_id_request_body | WorkspaceIdRequestBody | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceRead partial_update_source(partial_source_update) Partially update a source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| partial_source_update | PartialSourceUpdate | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceReadList search_sources(source_search) Search sources
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_search | SourceSearch | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::SourceRead update_source(source_update) Update a source
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_update | SourceUpdate | [required] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::DiscoverCatalogResult write_discover_catalog_result(source_discover_schema_write_request_body) Should only called from worker, to write result from discover activity back to DB.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| source_discover_schema_write_request_body | SourceDiscoverSchemaWriteRequestBody | [required] |
crate::models::DiscoverCatalogResult
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]