Struct ResourceDefinition 

pub struct ResourceDefinition {
    pub resource: String,
    pub version: u32,
    pub db: Option<String>,
    pub tenant_key: Option<String>,
    pub schema: IndexMap<String, FieldSchema>,
    pub endpoints: Option<IndexMap<String, EndpointSpec>>,
    pub relations: Option<IndexMap<String, RelationSpec>>,
    pub indexes: Option<Vec<IndexSpec>>,
}

Complete definition of a Shaperail resource, parsed from a resource YAML file.

This is the central type that all codegen and runtime modules consume.

resource: users
version: 1
schema:
  id: { type: uuid, primary: true, generated: true }
  email: { type: string, format: email, unique: true, required: true }

Fields

resource: String

Snake_case plural name of the resource (e.g., “users”).

version: u32

Schema version number (starts at 1).

db: Option<String>

Named database connection for this resource (M14). Default: “default”.

tenant_key: Option<String>

Tenant isolation key (M18). References a schema field (must be type uuid) that identifies the tenant. When set, all queries are automatically scoped to the authenticated user’s tenant_id claim. super_admin bypasses the filter.

schema: IndexMap<String, FieldSchema>

Field definitions, keyed by field name. Uses IndexMap to preserve declaration order.

endpoints: Option<IndexMap<String, EndpointSpec>>

Endpoint definitions, keyed by action name (e.g., “list”, “create”).

relations: Option<IndexMap<String, RelationSpec>>

Relationship definitions, keyed by relation name.

indexes: Option<Vec<IndexSpec>>

Additional database indexes.

Trait Implementations

impl Clone for ResourceDefinition

fn clone(&self) -> ResourceDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResourceDefinition

fn eq(&self, other: &ResourceDefinition) -> 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 ResourceDefinition

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 ResourceDefinition