Struct TraverseBody 

pub struct TraverseBody {
    pub direction: String,
    pub relation_types: Vec<String>,
    pub max_depth: Option<u32>,
    pub max_nodes: Option<u32>,
    pub include_superseded: bool,
}

POST /v1/entities/{id}/traverse body. The anchor entity comes from the path id; the body carries the walk parameters. All optional with sane defaults (outgoing, depth 3, 100 nodes).

Fields

direction: String

outgoing (default), incoming, or both.

relation_types: Vec<String>

Relation types to follow (empty = every type).

max_depth: Option<u32>

Max hop depth; omitted → 3, clamped to 1..=5.

max_nodes: Option<u32>

Max nodes to visit; omitted → 100, clamped to 1..=1000.

include_superseded: bool

Include superseded relations (default false).

Implementations

impl TraverseBody

pub fn to_request(&self, id: &str) -> Result<RelationTraverseRequest, String>

Build the wire request from the path id and this body. time_at = 0 means “as of now”.

Trait Implementations

impl Debug for TraverseBody

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

Formats the value using the given formatter.

impl Default for TraverseBody

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TraverseBody

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.