Struct RestConfig 

pub struct RestConfig {

    pub enabled: bool,
    pub path: String,
    pub max_page_size: u64,
    pub default_page_size: u64,
    pub default_embed_page_size: u64,
    pub ndjson_batch_size: u64,
    pub max_bulk_affected: u64,
    pub max_filter_bytes: u64,
    pub delete_response: DeleteResponse,
    pub default_cache_ttl: u64,
    pub cdn_max_age: Option<u64>,
    pub require_auth: bool,
    pub sse_heartbeat_seconds: u64,
    pub sse_max_replay_events: 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 (compiled from [rest] in fraiseql.toml).

Fields

enabled: bool

Whether the REST transport is enabled.

path: String

Base path for REST endpoints (e.g., "/rest/v1").

max_page_size: u64

Maximum rows per page (clamps ?limit= and ?first=).

default_page_size: u64

Default page size when no ?limit= is specified.

default_embed_page_size: u64

The page each parent row gets of an embedded relationship when the request names none (?select=orders(id) without ?orders.limit=).

Distinct from max_page_size, which is the ceiling a client may ask up to, and applied at most at that ceiling. An embedded level is charged its page for every parent row, so defaulting it to the ceiling charged an unpaged embed as if every parent had a full page of related rows.

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: DeleteResponse

How DELETE endpoints report success.

default_cache_ttl: u64

Default result cache TTL in seconds (0 = no caching): the max-age of a GET’s Cache-Control. An authenticated read (any credential) is private; only an anonymous read is public, and only a public one carries s-maxage.

cdn_max_age: Option<u64>

CDN s-maxage value in seconds for Cache-Control headers (None = omit).

require_auth: bool

Whether REST endpoints require authentication by default.

sse_heartbeat_seconds: u64

SSE heartbeat interval in seconds.

sse_max_replay_events: u64

How many delivered events a Last-Event-ID resume may reach back over (#1310).

A reconnecting client names the last event it received, and the stream replays everything delivered since. A resume point far behind the head is therefore a read proportional to how far behind it is, on the busiest table in the deployment — so a request that would reach back further than this is refused (413 RESUME_TOO_FAR_BEHIND) before a single frame is emitted, rather than served in part. The client can then reconnect without the header and knowingly start from now.

Counted across every entity type, because that is what the walk through the dispatch ledger costs, whatever share of it one resource turns out to be.

0 means no bound — every resume is served however far back it reaches. That is the permissive setting, and worth naming as such: on a stream reachable without a credential it hands an anonymous client an unbounded read.

max_embedding_depth: u32

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

include: Vec<String>

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

exclude: Vec<String>

Blacklist 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 RestConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestConfig

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

Formats the value using the given formatter.

impl Default for RestConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RestConfig

where RestConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RestConfig

impl PartialEq for RestConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RestConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RestConfig