Struct EndpointSpec 

pub struct EndpointSpec {

    pub method: Option<HttpMethod>,
    pub path: Option<String>,
    pub auth: Option<AuthRule>,
    pub input: Option<Vec<String>>,
    pub filters: Option<Vec<String>>,
    pub search: Option<Vec<String>>,
    pub pagination: Option<PaginationStyle>,
    pub sort: Option<Vec<String>>,
    pub cache: Option<CacheSpec>,
    pub controller: Option<ControllerSpec>,
    pub events: Option<Vec<String>>,
    pub jobs: Option<Vec<String>>,
    pub upload: Option<UploadSpec>,
    pub soft_delete: bool,
}

Specification for a single endpoint in a resource.

Matches the YAML format:

list:
  method: GET
  path: /users
  auth: [member, admin]
  pagination: cursor

When the endpoint name matches a known convention (list, get, create, update, delete), method and path can be omitted and will be inferred from the resource name. Use apply_endpoint_defaults() after parsing to fill them in.

Fields

method: Option<HttpMethod>

HTTP method (GET, POST, PATCH, PUT, DELETE). Optional when endpoint name is a known convention (list, get, create, update, delete).

path: Option<String>

URL path pattern (e.g., “/users”, “/users/:id”). Optional when endpoint name is a known convention (list, get, create, update, delete).

auth: Option<AuthRule>

Authentication/authorization rule.

input: Option<Vec<String>>

Fields accepted as input for create/update.

filters: Option<Vec<String>>

Fields available as query filters.

search: Option<Vec<String>>

Fields included in full-text search.

pagination: Option<PaginationStyle>

Pagination style for list endpoints.

sort: Option<Vec<String>>

Fields available for sorting.

cache: Option<CacheSpec>

Cache configuration.

controller: Option<ControllerSpec>

Controller functions for synchronous in-request business logic.

events: Option<Vec<String>>

Events to emit after successful execution.

jobs: Option<Vec<String>>

Background jobs to enqueue after successful execution.

upload: Option<UploadSpec>

File upload configuration.

soft_delete: bool

Whether this endpoint performs a soft delete.

Implementations

impl EndpointSpec

pub fn method(&self) -> &HttpMethod

Returns the resolved HTTP method. Panics if method is None (should never happen after apply_endpoint_defaults).

pub fn path(&self) -> &str

Returns the resolved path. Panics if path is None (should never happen after apply_endpoint_defaults).

Trait Implementations

impl Clone for EndpointSpec

fn clone(&self) -> EndpointSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EndpointSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EndpointSpec

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

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 EndpointSpec