Use Maps with GraphQL

View Source

If you define an Ash.Type.NewType that is a subtype of :map, and you add the fields constraint which specifies field names and their types, AshGraphql will automatically derive an appropriate GraphQL type for it.

For example:

defmodule MyApp.Types.Metadata do
  @moduledoc false
  use Ash.Type.NewType, subtype_of: :map, constraints: [
    fields: [
      title: [
        type: :string
      ],
      description: [
        type: :string
      ]
    ]
  ]

  def graphql_type(_), do: :metadata
end

Bypassing type generation for an map

Add the graphql_define_type?/1 callback, like so, to skip Ash's generation (i.e if you're defining it yourself)

@impl true
def graphql_define_type?(_), do: false