View Source AshAdmin.Api (ash_admin v0.8.0)

An API extension to alter the behavior of an API in the admin UI.

Table of Contents:

DSL Docs:

admin

admin

Configure the admin dashboard for a given API.


  • :name - The name of the API in the dashboard. Will be derived if not set.

  • :show? - Whether or not this API and its resources should be included in the admin dashboard. The default value is false.

  • :default_resource_page - Set the default page for the resource to be the primary read action or the resource schema. Schema is the default for backwards compatibility, if a resource doesn't have a primary read action it will fallback to the schema view. The default value is :schema.

  • :resource_group_labels - Humanized names for each resource group to appear in the admin area. These will be used as labels in the top navigation dropdown. If a key for a group does not appear in this mapping, the label will not be rendered. The default value is [].

Link to this section Summary

Link to this section Functions