Struct E2eOpExample 

pub struct E2eOpExample {
    pub description: String,
    pub args: Json,
    pub returns: Json,
}

A worked example: what to send, and what comes back.

Both halves matter. The arguments alone tell a caller how to invoke the op; the RETURN tells it what it can then assert on, which is what a scenario author and an agent each need before committing to a call.

Fields

description: String

args: Json

Example arguments — a real JSON value, not a string containing JSON.

These were String first, which serialized as escaped JSON inside JSON: every consumer parsed twice and nothing checked the inner text was even well-formed, so a malformed example sat in the schema looking fine.

returns: Json

What the op returns for those arguments.

MUST contain a success boolean — validated when the schema is installed, see E2eOpSchema::validate.

Trait Implementations

impl Clone for E2eOpExample

fn clone(&self) -> E2eOpExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for E2eOpExample

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

Formats the value using the given formatter.

impl Default for E2eOpExample

fn default() -> E2eOpExample

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for E2eOpExample

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for E2eOpExample

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for E2eOpExample

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 E2eOpExample