Skip to main content

Module schema

Module schema 

Source

Structs§

ChildHashes
ChildSummary
Summary of a child plugin
CredentialFieldDecl
One entry per credential-bearing field in a method’s return type.
DeprecationInfo
Structured deprecation metadata attached to a MethodSchema.
MethodExample
SYNAPSE-13: one worked call of a method — the params it sends and a note saying what it does (#[plexus_macros::method(example(note = "…", params = r#"{…}"#))]).
MethodSchema
Schema for a single method exposed by a plugin
ParamSchema
Per-parameter metadata for a method’s parameters.
PluginHashes
Schema summary containing only hashes (for cache validation)
PluginSchema
A plugin’s schema with methods and child summaries.
RequiredCredential
What a method requires on input — the implicit-derivation projection of scope tagging and credential-graph linkage onto a per-method filter.
Schema
A complete JSON Schema with metadata
SchemaProperty
A property definition in a schema
Scope
Re-exported so macro-generated code (R-1: #[plexus::method(scope = "...")]) can construct RequiredCredential scope values through plexus-core’s path alone — consumers don’t need a direct plexus-auth-core dependency (the umbrella path ::plexus_rpc::core::plexus::schema::Scope also resolves, per Z2H-2). Atomic capability identifier, e.g. cone.send_message. Canonical Scope newtype pinned by AUTHZ-S01-output §1. The grammar-validated constructor (Scope::try_new), wildcard predicate (is_wildcard), and segment-bounded matching (Scope::matches) live in crate::scope_registry (AUTHZ-CORE-4). The macro-generated Scope::new below stays unvalidated for wire-decoded values; registry construction goes through try_new.

Enums§

AuthPosture
Declared auth-enforcement posture of the activation a method belongs to.
HttpMethod
HTTP method for REST endpoint routing
MethodRole
Describes how a method participates in the activation graph.
ReturnShape
Describes the structural shape of a method’s return type.
SchemaResult
Result of a schema query - either full plugin or single method
SchemaType
Schema type enumeration
ViewKind
AUTH-4: the two views of a gated hub. On the wire, "anonymous" or "caller".

Constants§

X_PLEXUS_VALUES
SYNAPSE-13: the JSON Schema extension key on a param’s property that lists the values it is meant to take — a hint for help and completion, never enforced (the server may accept synonyms, e.g. active for Coding).