philomena/lib/philomena_query/search_index.ex

defmodule PhilomenaQuery.SearchIndex do
  # Returns the index name for the index.
  # This is usually a collection name like "images".
  @callback index_name() :: String.t()

  # Returns the mapping and settings for the index.
  @callback mapping() :: map()

  # Returns the JSON representation of the given struct for indexing in OpenSearch.
  @callback as_json(struct()) :: map()
end