API Reference ash_json_api v0.31.3
Introspection functions for
The entrypoint for adding JSON:API behavior to an Ash API
Introspection helpers for AshJsonApi.Api
Use this module to create a router for your AshJsonApi.
Represents an AshJsonApi Error
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 occurred.
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
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
Provides functions for generating schemas and operations for OpenApi definitions.
The entrypoint for adding JSON:API behavior to a resource"
Introspection helpers for AshJsonApi.Resource
Represents a route for a resource
Ensures that the
base route is prepended to each route
Ensures that the resource either has a primary key
Validates that all method/route combinations are unique