AshJsonApi.Resource (ash_json_api v0.24.0) View Source

The entrypoint for adding JSON:API behavior to a resource

Link to this section Summary

Link to this section Functions

Link to this function

encode_primary_key(record)

View Source
Link to this macro

json_api(body)

View Source (macro)

Configure the resource's behavior in the JSON:API

Options

  • :type - Required. The resource identifier type of this resource in JSON:API

  • :includes - A keyword list of all paths that are includable from this resource The default value is [].

Sections

Link to this function

primary_key_delimeter(resource)

View Source
Link to this function

primary_key_fields(resource)

View Source
Link to this function

route(resource, criteria \\ %{})

View Source