Struct LinkDefinition 

pub struct LinkDefinition {
    pub link_type: String,
    pub source_type: String,
    pub target_type: String,
    pub forward_route_name: String,
    pub reverse_route_name: String,
    pub description: Option<String>,
    pub required_fields: Option<Vec<String>>,
    pub auth: Option<LinkAuthConfig>,
}

Configuration for a specific type of link between two entity types

This defines how entities can be related and how those relationships are exposed through the API

Fields

link_type: String

The type of link (e.g., “owner”, “driver”)

source_type: String

The source entity type (e.g., “user”)

target_type: String

The target entity type (e.g., “car”)

forward_route_name: String

Route name when navigating from source to target

Example: “cars-owned” → /users/{id}/cars-owned

reverse_route_name: String

Route name when navigating from target to source

Example: “users-owners” → /cars/{id}/users-owners

description: Option<String>

Optional description of this link type

required_fields: Option<Vec<String>>

Optional list of required metadata fields

auth: Option<LinkAuthConfig>

Authorization configuration specific to this link type

When specified, these permissions override entity-level link permissions. This allows different link types between the same entities to have different permission requirements.

Examples:

• order → invoice: create=service_only (auto-created by system)
• order → approval: create=owner (manually created by user)

Implementations

impl LinkDefinition

pub fn default_forward_route_name(target_type: &str, link_type: &str) -> String

Generate the default forward route name

Format: {target_plural}-{link_type_plural} Example: “cars-owned” for (target=“car”, link_type=“owner”)

pub fn default_reverse_route_name(source_type: &str, link_type: &str) -> String

Generate the default reverse route name

Format: {source_plural}-{link_type_plural} Example: “users-owners” for (source=“user”, link_type=“owner”)

Trait Implementations

impl Clone for LinkDefinition

fn clone(&self) -> LinkDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LinkDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LinkDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LinkDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.