Gleanex.Indexing.Shortcuts (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to shortcuts

Summary

Functions

bulkindexshortcuts(body, opts \\ [])

Bulk index external shortcuts

uploadshortcuts(body, opts \\ [])

Upload shortcuts

Functions

bulkindexshortcuts(body, opts \\ [])

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

Bulk index external shortcuts

Replaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the /uploadshortcuts endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to this page.

Request Body

Content Types: application/json; charset=UTF-8

uploadshortcuts(body, opts \\ [])

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

Upload shortcuts

Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded.

Request Body

Content Types: application/json; charset=UTF-8