View Source API Reference ash_json_api v1.4.11

Introspection functions for AshJsonApi domains.

The entrypoint for adding JSON:API behavior to an Ash domain

Introspection target for base routes in AshJsonApi.Domain

Introspection helpers for AshJsonApi.Domain

Verifies that all actions are valid for each route.

Verifies that a resource has a type if it has any routes that need it.

Verify query params are not reserved or shadowed by the route

Verifies that any routes that reference a relationship reference a public one

Represents an AshJsonApi Error

Returned when the request body provided is invalid

Returned when a field is requested that does not exist or is invalid

Returned when a header provided is invalid

Returned when the includes string provided in the query parameter include is invalid.

Returned when one of the nested parameters provided in the query parameter page is invalid

Returned when the query provided is invalid

Returned when a field is requested for a type that does not exist or is invalid

Returned when a record was explicitly requested, but could not be found.

Returned when the client does not provide (via the Content-Type header) the correct json API media type: application/vnd.api+json

Returned when the client does not accept (via the Accept header) the json API media type: application/vnd.api+json

Codemods and utilities for working with AshJsonApi & Igniter

Provides functions for generating schemas and operations for OpenApi definitions.

Extracts ash multipart request body.

The entrypoint for adding JSON:API behavior to a resource"

Introspection helpers for AshJsonApi.Resource

Represents a route for a resource

Verifies that all actions are valid for each route.

Verifies that a resource has a type if it has any routes that need it.

Verifies that all includes are valid public relationships

Verify query params are not reserved or shadowed by the route

Verifies that any routes that reference a relationship reference a public one

Use this module to create a router for your AshJsonApi.

A protocol for turning an Ash exception into an AshJsonApi.Error

The behaviour for customizing how a datatype is rendered and written in AshJsonApi.

Installs AshJsonApi. Should be run with mix igniter.install ash_json_api