Struct HttpAnnotations 

pub struct HttpAnnotations {
    pub method: HttpMethod,
    pub path: String,
    pub param_bindings: BTreeMap<String, HttpParamBinding>,
    pub request_body_name: Option<String>,
    pub status_codes: Vec<u16>,
    pub auth: Option<AuthRequirement>,
    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
}

Parsed HTTP metadata for a single SQL query.

Fields

method: HttpMethod

path: String

Path normalized to spikard’s canonical {name} form. Both :id and {id} are accepted in source and emitted as {id}.

param_bindings: BTreeMap<String, HttpParamBinding>

Explicit param-location overrides, keyed by parameter name. Names absent from this map fall back to inference rules (see bin_param_locations).

request_body_name: Option<String>

Name of the bundled body object when multiple body params exist.

status_codes: Vec<u16>

Status codes the route documents (defaults derived from the SQL QueryCommand when empty).

auth: Option<AuthRequirement>

tags: Vec<String>

summary: Option<String>

description: Option<String>

Trait Implementations

impl Clone for HttpAnnotations

fn clone(&self) -> HttpAnnotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpAnnotations

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpAnnotations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpAnnotations

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

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 HttpAnnotations

impl StructuralPartialEq for HttpAnnotations