Struct RestConfig 

pub struct RestConfig {

    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: DeleteResponse,
    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 (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.

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).

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.

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

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 PartialEq for RestConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 Eq for RestConfig

impl StructuralPartialEq for RestConfig