ash-project/ash_admin
1
0
Fork 0
mirror of https://github.com/ash-project/ash_admin.git synced 2024-09-20 05:12:54 +12:00
Code Issues Projects Releases Packages Wiki Activity
ash_admin/documentation/dsls/DSL:-AshAdmin.Api.md
Zach Daniel 62417088e3 chore: docs
2024-02-04 10:42:01 -05:00

1.3 KiB
Raw Blame History

DSL: AshAdmin.Api

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

admin

Configure the admin dashboard for a given API.

Options

Name Type Default Docs
name{: #admin-name } String.t The name of the API in the dashboard. Will be derived if not set.
show?{: #admin-show? } boolean false Whether or not this API and its resources should be included in the admin dashboard.
default_resource_page{: #admin-default_resource_page } :schema | :primary_read :schema 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.
resource_group_labels{: #admin-resource_group_labels } keyword [] 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.