ash_json_api v0.2.0 API Reference

Modules

Tools for introspecting ash json api resources/apis.

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

Defines a router module to be included in the router

Tools for control flow around a request, and common controller utilities.

Returned when a actor is not allowed to perform an action, or when a actor is not present, but must be in order to perform an action.

Returned when an unexpected error in the framework has occured.

Returned when the request body provided 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 record was explicitly requested, but could not be found.

Returned when the client does not accept the json API media type: application/vnd.api+json

The entrypoint for adding JSON:API behavior to a resource

Configure the routes that will be exposed via the JSON:API

Ensures that the base route is prepended to each route

Validates that all method/route combinations are unique