Struct RestTomlConfig 

pub struct RestTomlConfig {

    pub enabled: bool,
    pub path: String,
    pub max_page_size: u64,
    pub default_page_size: u64,
    pub ndjson_batch_size: u64,
    pub max_bulk_affected: u64,
    pub max_filter_bytes: u64,
    pub delete_response: DeleteResponseToml,
    pub default_cache_ttl: u64,
    pub cdn_max_age: Option<u64>,
    pub require_auth: bool,
    pub sse_heartbeat_seconds: u64,
    pub max_embedding_depth: u32,
    pub include: Vec<String>,
    pub exclude: Vec<String>,
    pub etag: bool,
    pub idempotency_ttl_seconds: u64,
}

REST transport configuration parsed from the [rest] TOML section.

All fields have defaults matching RestConfig::default() in fraiseql-core. When enabled is false (the default), the REST transport is not mounted.

Fields

enabled: bool

Whether the REST transport is enabled.

path: String

Base URL path for REST endpoints.

max_page_size: u64

Maximum rows per page (clamps ?limit=).

default_page_size: u64

Default page size when no ?limit= is specified.

ndjson_batch_size: u64

Batch size for NDJSON streaming responses.

max_bulk_affected: u64

Maximum affected rows for bulk PATCH/DELETE.

max_filter_bytes: u64

Maximum byte length for ?filter= JSON values.

delete_response: DeleteResponseToml

How DELETE endpoints report success: "no_content" (default) or "entity".

default_cache_ttl: u64

Default result cache TTL in seconds (0 = no caching).

cdn_max_age: Option<u64>

CDN s-maxage value in seconds (None = omit).

require_auth: bool

Whether REST endpoints require authentication by default.

sse_heartbeat_seconds: u64

SSE heartbeat interval in seconds.

max_embedding_depth: u32

Maximum depth for resource embedding (?select=posts(comments)).

include: Vec<String>

Allowlist of type names to expose as REST resources (empty = all).

exclude: Vec<String>

Denylist of type names to exclude from REST resources.

etag: bool

Whether to enable ETag / If-None-Match conditional response support.

idempotency_ttl_seconds: u64

TTL in seconds for idempotency key deduplication.

Trait Implementations

impl Clone for RestTomlConfig

fn clone(&self) -> RestTomlConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestTomlConfig

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

Formats the value using the given formatter.

impl Default for RestTomlConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RestTomlConfig

where RestTomlConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RestTomlConfig> for RestConfig

fn from(toml: RestTomlConfig) -> Self

Converts to this type from the input type.

impl Serialize for RestTomlConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.