OpenApiTypesense.Override (OpenApiTypesense v0.6.5)

View Source

Provides API endpoint related to override

Summary

Functions

get_search_override(collectionName, overrideId)

@spec get_search_override(String.t(), String.t()) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a single search override

Retrieve the details of a search override, given its id.

get_search_override(collectionName, overrideId, opts)

@spec get_search_override(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

  • get_search_override(collectionName, overrideId, opts)
  • get_search_override(%{api_key: xyz, host: ...}, collectionName, overrideId)
  • get_search_override(Connection.new(), collectionName, overrideId)

get_search_override(conn, collectionName, overrideId, opts)

Either one of:

  • get_search_override(%{api_key: xyz, host: ...}, collectionName, overrideId, opts)
  • get_search_override(Connection.new(), collectionName, overrideId, opts)