Expand description
JSON control-plane protocol types for the AHRI TRE CLI and daemon.
The protocol crate contains serializable request and response envelopes only; it does not execute workflows or open datastore connections. Keeping these contracts small lets CLI, daemon, and tests share command payloads without coupling to runtime adapters.
Re-exports§
pub use ids::PublicName;pub use ids::PublicUuid;pub use ids::RequestId;pub use protocol_envelope::ProtocolFailureEnvelope;pub use protocol_envelope::ProtocolRequestEnvelope;pub use protocol_envelope::ProtocolResponseEnvelope;pub use protocol_envelope::ProtocolSuccessEnvelope;pub use public_error::HttpPublicError;pub use public_error::HttpPublicErrorEnvelope;pub use public_error::ProtocolError;pub use public_error::ProtocolErrorCode;pub use public_error::ProtocolErrorDetails;pub use public_error::ValidationIssue;pub use public_error::ValidationIssueCode;pub use public_error::ValidationIssueDetails;pub use version::CURRENT_PROTOCOL_VERSION;pub use version::PROTOCOL_COMPATIBILITY_RULE;pub use version::ProtocolCompatibility;pub use version::ProtocolCompatibilityRange;pub use version::ProtocolVersion;pub use version::ProtocolVersionError;pub use version::current_protocol_compatibility;pub use warning::ProtocolWarning;pub use warning::ProtocolWarningCode;pub use warning::ProtocolWarningDetails;pub use error::*;
Modules§
- access_
request - Public Study access-request submission contracts.
- acquisition
- Non-secret acquisition intent. Authentication bytes use a separate channel.
- asset
- Public asset catalog DTOs.
- catalogue
- Public Study access-request submission DTOs. Safe nested catalogue records with reusable Datastore-bound references.
- content
- Governed content admission and finite transfer descriptors. JSON control documents for the separately framed content channel.
- datafile
- Public datafile catalog DTOs.
- dataset
- Public dataset catalog DTOs.
- datastore
- Public datastore DTOs.
- diagnostics
- Safe observation metadata for existing diagnostic reports. Optional observation metadata for existing diagnostic reports.
- dictionary
- Public dictionary DTOs.
- dictionary_
discovery - Browser-safe data dictionary Discovery metadata DTOs.
- domain
- Public domain DTOs.
- error
- Protocol-level exit codes and serializable error payloads.
- execution_
profile - Safe Execution-profile discovery and logical-selection DTOs. Safe Execution-profile discovery and logical-selection contracts.
- ids
- Stable public ID and name wrappers.
- ingest
- Public ingest workflow DTOs.
- lifecycle
- Public destructive lifecycle workflow DTOs.
- model
- Public model DTOs.
- mutation
- Mutation idempotency and precondition DTOs.
- operation
- Public long-running operation DTOs.
- pagination
- Cursor pagination DTOs.
- protocol_
envelope - Stable protocol request and response envelopes.
- public_
error - Stable public protocol error DTOs.
- readiness
- Public daemon readiness DTOs.
- refs
- Stable public references and selectors.
- request
- Stable top-level protocol request DTOs.
- resource_
discovery - Browser-safe dataset and datafile Discovery metadata DTOs.
- runtime_
capabilities - Trusted-runtime stable-protocol capability reporting DTOs. Trusted-runtime stable-protocol capability reporting contracts.
- search
- Structured catalog search DTOs.
- semantic_
discovery - Browser-safe semantic catalog and provenance Discovery metadata DTOs. Browser-safe semantic catalog and provenance Discovery metadata DTOs.
- session
- Public session DTOs.
- study
- Public study DTOs.
- tabular
- Tabular data-plane reference DTOs.
- tag
- Public tag management DTOs.
- transformation
- Public transformation catalog DTOs.
- upload
- Path-free control metadata for a synchronous, integrity-checked upload.
- version
- Protocol version DTOs and constants.
- warning
- Stable public warning DTOs.