Gleanex.Indexing.Datasources (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to datasources

Summary

Types

submissions_datasource_instance_type_202_json_resp()

Functions

adddatasource(body, opts \\ [])

Add or update datasource

getdatasourceconfig(body, opts \\ [])

Get datasource config

submissions_datasource_instance_type(datasourceInstance, type, body, opts \\ [])

Submit datasource data

Types

submissions_datasource_instance_type_202_json_resp()

@type submissions_datasource_instance_type_202_json_resp() :: %{requestId: String.t()}

Functions

adddatasource(body, opts \\ [])

@spec adddatasource(
  body :: Gleanex.Indexing.CustomDatasourceConfig.t(),
  opts :: keyword()
) ::
  :ok | {:error, Gleanex.Error.t()}

Add or update datasource

Add or update a custom datasource and its schema.

Request Body

Content Types: application/json

getdatasourceconfig(body, opts \\ [])

@spec getdatasourceconfig(
  body :: Gleanex.Indexing.GetDatasourceConfigRequest.t(),
  opts :: keyword()
) ::
  {:ok, Gleanex.Indexing.CustomDatasourceConfig.t()}
  | {:error, Gleanex.Error.t()}

Get datasource config

Fetches the datasource config for the specified custom datasource.

Request Body

Content Types: application/json

submissions_datasource_instance_type(datasourceInstance, type, body, opts \\ [])

@spec submissions_datasource_instance_type(
  datasourceInstance :: String.t(),
  type :: String.t(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, submissions_datasource_instance_type_202_json_resp()}
  | {:error, Gleanex.Error.t()}

Submit datasource data

Validates and asynchronously processes a datasource-specific submission.

Request Body

Content Types: application/json