AshJsonApi.Resource.Routes.Relationship (ash_json_api v0.24.0) View Source

Link to this section Summary

Functions

A READ route to read the relationship, returns resource identifiers.

Link to this section Functions

Link to this macro

relationship(relationship, action, opts \\ [])

View Source (macro)

A READ route to read the relationship, returns resource identifiers.

Examples

relationship :comments, :default

Arguments

  • :relationship

  • :action - The action to call when this route is hit

Options

  • :route - The path of the route - Defaults to /:id/relationships/[relationship_name]

  • :primary? - Whether or not this is the route that should be linked to by default when rendering links to this type of route The default value is false.