Struct QueryRequest 

pub struct QueryRequest {
    pub query: String,
    pub name: Option<String>,
    pub params: Option<Value>,
    pub branch: Option<String>,
    pub snapshot: Option<String>,
}

Inline read-query request for POST /query.

Friendlier-named alternative to ReadRequest for ad-hoc reads and AI-agent integration. Mutations are rejected with 400 — use POST /mutate (or its deprecated alias POST /change) for write queries. Field names are deliberately short (query, name) to match the GQ keyword and the CLI -e flag.

Fields

query: String

GQ read-query source. May declare one or more named queries; pick one with name when more than one is declared. Mutations (insert/update/delete) get 400 — use POST /mutate (or its deprecated alias POST /change) instead.

name: Option<String>

Name of the query to run when query declares multiple. Optional when only one query is declared.

params: Option<Value>

JSON object whose keys match the query’s declared parameters.

branch: Option<String>

Branch to read from. Mutually exclusive with snapshot. Defaults to main.

snapshot: Option<String>

Snapshot id to read from. Mutually exclusive with branch.

Trait Implementations

impl Clone for QueryRequest

fn clone(&self) -> QueryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<QueryRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for QueryRequest

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.