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
SchemaParams
SYNAPSE-CC-9: the params of every activation’s schema method.
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.
Cardinality
How many items a method yields: exactly one, or a stream of them.
HttpMethod
HTTP method for REST endpoint routing
MethodRole
Describes how a method participates in the activation graph.
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§

CONTRACT_KEYWORDS
SYNAPSE-CC-9: the closed list of keywords synapse reads in a type position (IR 2.1). Any other is reported by foreign_keywords.
JSON_TYPES
SYNAPSE-CC-9: the JSON type — what a serde_json::Value is, the JSON sum type — as plexus spells it in a schema: {"type": [these six]}, in this order, inline (never a $ref), annotations beside it. schemars writes a Value as true (or annotations alone); spell_json_values rewrites each such position to this, and every MethodSchema schema setter applies it, so the schema says “any JSON value” one way, which a client reads as a type (SYNAPSE-CC-8’s RefJson). The owner, 2026-10-29: nothing is opaque.
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).

Functions§

foreign_keywords
Every keyword outside the closed list, as <site>: <keyword>, sorted.
is_json_type
SYNAPSE-CC-9: is this schema node “any JSON value” — true, {}, annotations alone, or the spelled JSON type? An injected parameter (x-plexus-source) is not a value a client sends, so never.
schema_untyped_sites
untyped_sites for one type’s schema (schema_for!(T)), its root named <ns>.<title>.
spell_json_values
SYNAPSE-CC-9: rewrite every “any JSON value” position in schema — true, {}, annotations alone — to the JSON type ({"type": JSON_TYPES}, annotations kept), through properties, items, prefixItems, additionalProperties, the unions and $defs. Idempotent; a typed node and an injected parameter are left as they are. In place: a schemars Schema is a JSON value, so nothing is copied.
untyped_sites
Every untyped site in this plugin’s schema (its RPC methods’ params, returns, request/response types and input, and its request struct), sorted. Empty is the contract.