ash v1.37.2
ash

Ash.Api.Dsl (ash v1.37.2) View Source

A small DSL for declaring APIs

Apis are the entrypoints for working with your resources.

Table of Contents

resources

List the resources present in this API

Examples:

resources do
  resource MyApp.User
  resource MyApp.Post
  resource MyApp.Comment
end

resource

A reference to a resource

Introspection Target:

Ash.Api.ResourceReference

Examples:

resource MyApp.User

  • :as - false A short name for the resource.

    Can be used in calls to Api modules, e.g Api.read(:special_thing).

  • :resource - Required. The module of the resource