@callback default_filters() :: [map()] | nil

Array of default field filters to be used when there are no filters present

@callback model() :: module()

Must return the module implementing Ecto.Schema to be represented.

Example:

def model, do: MyApp.Models.Post

Defaults to the name of the resource, for example the resource MyApp.V1.PostResource would serve the MyApp.Post model.

Used by the default implementations for handle_create/2, handle_update/3, and records/1.

@callback search() :: [atom()]

The fields that should be searched

@callback singular_title() :: String.t()

Returns the singularized version of the title to display on forms.

@callback subtitle_for_schema(struct()) :: String.t() | nil

Returns the subtitle to display in relationships.

Defaults to looking for name or title fields, falls back to the schemas name appended by it's id

@callback thumbnail_for_schema(struct()) :: String.t() | nil

Returns the thumbnail to display in search.

Defaults to looking for name or title fields, falls back to the schemas name appended by it's id

@callback title() :: String.t()

Returns the title to display in the side bar.

Defaults to finding the title from the resource modules name

@callback title_for_schema(struct()) :: String.t() | nil

Returns the title to display in relationships.

Defaults to looking for name or title fields, falls back to the schemas name appended by it's id

@callback uri() :: String.t()

Returns the uri to display in the side bar.

Defaults to finding the uri from the resource modules name