@spec default_fields(module()) :: [atom()] | nil

Gets the default fields to include in responses for a resource.

If configured, responses will only include the specified fields unless the client requests additional fields via sparse fieldsets.

Parameters

• resource - The Ash resource module

Returns

List of field names (as atoms) or nil for all fields.

Examples

iex> Config.default_fields(MyApp.Post)
[:id, :title, :body]

iex> Config.default_fields(MyApp.Comment)
nil

@spec derive_filter?(module()) :: boolean()

Checks whether filter schemas should be auto-derived for a resource.

When enabled, the OpenAPI generator will create detailed filter parameter schemas based on the resource's attributes.

Parameters

• resource - The Ash resource module

Returns

Boolean indicating if filter derivation is enabled.

Examples

iex> Config.derive_filter?(MyApp.Post)
true

@spec derive_sort?(module()) :: boolean()

Checks whether sort schemas should be auto-derived for a resource.

When enabled, the OpenAPI generator will create sort parameter schemas listing all sortable fields.

Parameters

• resource - The Ash resource module

Returns

Boolean indicating if sort derivation is enabled.

Examples

iex> Config.derive_sort?(MyApp.Post)
true

@spec domain_resources(module()) :: [module()]

Gets all resources in a domain.

Parameters

• domain - The Ash domain module

Returns

List of resource modules.

Examples

iex> Config.domain_resources(MyApp.Blog)
[MyApp.Post, MyApp.Comment, MyApp.Author]

@spec domain_routes(module()) :: [map()]

Gets the JSON:API routes for a domain.

Parameters

• domain - The Ash domain module

Returns

List of route structs.

Examples

Config.domain_routes(MyApp.Blog)
# => [%{type: :index, ...}, %{type: :get, ...}, ...]

@spec domain_tag(module()) :: String.t() | nil

Gets the OpenAPI tag for a domain.

Tags are used to group operations in OpenAPI documentation tools like Swagger UI.

Parameters

• domain - The Ash domain module

Returns

The tag name as a string, or nil if not configured.

Examples

iex> Config.domain_tag(MyApp.Blog)
"Blog"

@spec group_by(module()) :: atom() | nil

Gets the operation grouping strategy for a domain.

Determines how operations are grouped in the OpenAPI spec.

Parameters

• domain - The Ash domain module

Returns

The grouping strategy atom (e.g., :resource, :domain), or nil.

Examples

iex> Config.group_by(MyApp.Blog)
:resource

@spec includes(module()) :: [atom() | String.t()] | nil

Gets the available relationship includes for a resource.

Defines which relationships can be included via the include query parameter. Returns nil if not configured.

Parameters

• resource - The Ash resource module

Returns

List of includable relationship paths, or nil if not configured.

Examples

iex> Config.includes(MyApp.Post)
[:author, :comments, "comments.author"]

@spec json_argument_name(module(), atom(), atom() | String.t()) :: String.t()

Returns the JSON:API argument name for an action argument.

Applies the resource's argument_names mapping when the resource uses AshJsonApi.Resource; otherwise falls back to the atom/string name.

@spec json_field_name(module(), atom() | String.t()) :: String.t()

Returns the JSON:API field name for a resource field.

Applies the resource's field_names mapping when the resource uses AshJsonApi.Resource; otherwise falls back to the atom/string name.

@spec primary_key(module()) :: [atom()]

Gets the primary key field name(s) for a resource.

Parameters

• resource - The Ash resource module

Returns

List of primary key field names (as atoms).

Examples

iex> Config.primary_key(MyApp.Post)
[:id]

@spec public_attributes(module()) :: [map()]

Gets the public attributes for a resource.

Returns only attributes marked public? true, which are the ones that belong in OpenAPI schemas.

Parameters

• resource - The Ash resource module

Returns

List of attribute structs.

@spec relationship(module(), atom()) :: map() | nil

Gets a specific relationship for a resource by name.

Parameters

• resource - The Ash resource module
• name - The relationship name (atom)

Returns

The relationship struct or nil if not found.

@spec relationships(module()) :: [map()]

Gets the relationships for a resource.

Parameters

• resource - The Ash resource module

Returns

List of relationship structs.

@spec resource_action(module(), atom()) :: map() | nil

Gets a specific action for a resource by name.

Parameters

• resource - The Ash resource module
• action_name - The action name (atom)

Returns

The action struct or nil if not found.

@spec resource_actions(module()) :: [map()]

Gets the actions for a resource.

Parameters

• resource - The Ash resource module

Returns

List of action structs.

@spec resource_display_name(module()) :: String.t()

Returns the PascalCase display name for a resource, used to build schema and tag names.

Derives from the resource's declared JSON:API type when present — so a deeply nested module like MyApp.Reconciliation.State with type "reconciliation-state" names its schemas ReconciliationState* instead of the ambiguous State*. Falls back to the module's short name when no type is declared.

Examples

iex> AshOaskit.Config.resource_display_name(MyApp.Blog.Post)
"Post"

@spec resource_type(module()) :: String.t()

Gets the JSON:API type name for a resource.

The type is used in JSON:API responses as the type field and in route generation. If not explicitly configured, defaults to the underscored resource module name.

Parameters

• resource - The Ash resource module

Returns

The JSON:API type as a string.

Examples

iex> Config.resource_type(MyApp.BlogPost)
"blog_post"

iex> Config.resource_type(MyApp.User)
"user"

@spec route_prefix(module()) :: String.t()

Gets the route prefix for a domain.

The prefix is prepended to all resource routes in the domain.

Parameters

• domain - The Ash domain module

Returns

The route prefix as a string (empty string if not configured).

Examples

iex> Config.route_prefix(MyApp.Blog)
"/api/v1"

iex> Config.route_prefix(MyApp.Admin)
"/admin"

@spec show_field?(module(), atom() | map()) :: boolean()

Returns whether a field should be exposed in JSON:API output and specs.

Applies hide_fields/show_fields for AshJsonApi resources and defaults to true for plain Ash resources.