Struct PluginSchema 

pub struct PluginSchema {
    pub namespace: String,
    pub version: String,
    pub description: String,
    pub long_description: Option<String>,
    pub self_hash: String,
    pub children_hash: Option<String>,
    pub hash: String,
    pub methods: Vec<MethodSchema>,
    pub children: Option<Vec<ChildSummary>>,
    pub request: Option<Value>,
}

A plugin’s schema with methods and child summaries.

Children are represented as summaries (namespace, description, hash) rather than full recursive schemas. This enables lazy traversal - clients can fetch child schemas individually via {namespace}.schema.

• Leaf plugins have children = None
• Hub plugins have children = Some([ChildSummary, ...])

Fields

namespace: String

The plugin’s namespace (e.g., “echo”, “plexus”)

version: String

The plugin’s version (e.g., “1.0.0”)

description: String

Short description of the plugin (max 15 words)

long_description: Option<String>

Detailed description of the plugin (optional)

self_hash: String

Hash of ONLY this plugin’s methods (ignores children) Changes when method signatures, names, or descriptions change

children_hash: Option<String>

Hash of ONLY child plugin hashes (None for leaf plugins) Changes when any child’s hash changes (recursively)

hash: String

Composite hash = hash(self_hash + children_hash) Use this if you want a single hash for the entire subtree Backward compatible with previous single-hash system

methods: Vec<MethodSchema>

Methods exposed by this plugin

children: Option<Vec<ChildSummary>>

Child plugin summaries (None = leaf plugin, Some = hub plugin)

request: Option<Value>

JSON Schema for the HTTP request type this activation extracts from incoming connections.

Present when the activation declares request = MyRequest in #[plexus::activation(...)]. The schema includes x-plexus-source extension fields on each property describing where each field is sourced from (cookie, header, query param, peer address, etc.).

Clients can use this to understand what request data the activation expects and to generate appropriate authentication/context documentation.

Implementations

impl PluginSchema

pub fn leaf( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, methods: Vec<MethodSchema>, ) -> Self

Create a new leaf plugin schema (no children)

pub fn leaf_with_long_description( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, long_description: impl Into<String>, methods: Vec<MethodSchema>, ) -> Self

Create a new leaf plugin schema with long description

pub fn hub( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, methods: Vec<MethodSchema>, children: Vec<ChildSummary>, ) -> Self

Create a new hub plugin schema (with child summaries)

pub fn hub_with_long_description( namespace: impl Into<String>, version: impl Into<String>, description: impl Into<String>, long_description: impl Into<String>, methods: Vec<MethodSchema>, children: Vec<ChildSummary>, ) -> Self

Create a new hub plugin schema with long description

pub fn is_hub(&self) -> bool

Check if this is a hub (has children)

pub fn is_leaf(&self) -> bool

Check if this is a leaf (no children)

Trait Implementations

impl Clone for PluginSchema

fn clone(&self) -> PluginSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PluginSchema

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for PluginSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.