ash_json_api v0.5.0 AshJsonApi.Resource View Source

The entrypoint for adding JSON:API behavior to a resource

Link to this section Summary

Functions

Configure the resource's behavior in the JSON:API

Link to this section Functions

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

  • :fields - The field names and relationship names that should be part of the JSON:API resource The default value is [].

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

Sections