#![cfg(all(feature = "schemars", feature = "std"))]
#[allow(unused_imports)]
use alloc::vec::Vec;
#[cfg(feature = "time")]
use crate::run::RunResult;
#[cfg(feature = "otel-keys")]
use crate::telemetry::OtlpKeys;
use crate::{
ApiKeyRef, ArtifactRef, ArtifactSelector, Attachment, AttestationId, AttestationRef,
AttestationStatement, BranchRef, BuildLogRef, BuildPlan, BuildRef, BuildStatus, BundleSpec,
Capabilities, CapabilityMap, ChannelMessageEnvelope, Collection, CommitRef, ComponentId,
ComponentManifest, ComponentRef, ConnectionKind, DesiredState, DesiredStateExportSpec,
DesiredSubscriptionEntry, Diagnostic, Environment, EnvironmentRef, EventEnvelope,
EventProviderDescriptor, Flow, FlowId, FlowResolveSummaryV1, FlowResolveV1, GitProviderRef,
HashDigest, LayoutSection, Limits, MetadataRecord, MetadataRecordRef, Node, NodeFailure,
NodeId, NodeStatus, NodeSummary, OciImageRef, PackId, PackManifest, PackOrComponentRef,
PlanLimits, PolicyInputRef, PolicyRef, PriceModel, ProductOverride, ProviderDecl,
ProviderExtensionInline, ProviderInstallId, ProviderInstallRecord, ProviderManifest,
ProviderRuntimeRef, RedactionPath, RegistryRef, RepoAuth, RepoContext, RepoRef, RepoSkin,
RepoTenantConfig, RolloutStatus, RunStatus, SbomRef, ScanRef, ScanRequest, ScanResult,
ScannerRef, SecretsCaps, SemverReq, Severity, SignRequest, SignatureRef, SigningKeyRef,
StatementRef, StoreContext, StoreFront, StorePlan, StoreProduct, StoreProductKind, StoreRef,
Subscription, SubscriptionStatus, TelemetrySpec, TenantContext, TenantDidDocument, Theme,
ToolsCaps, TranscriptOffset, ValidationReport, VerifyRequest, VerifyResult, VersionRef,
VersionStrategy, WebhookId, WorkerMessage, WorkerRequest, WorkerResponse, ids,
};
use schemars::{JsonSchema, Schema, schema_for};
fn schema_with_id<T: JsonSchema>(id: &str) -> Schema {
let mut schema: Schema = schema_for!(T);
if schema.get("$id").is_none() {
schema.insert("$id".to_owned(), id.into());
}
schema
}
#[cfg(feature = "schema")]
#[derive(Clone, Copy)]
pub(crate) struct SchemaEntry {
pub file_name: &'static str,
pub generator: fn() -> Schema,
}
macro_rules! define_schema_fn {
($(#[$meta:meta])* $fn_name:ident, $ty:ty, $id_const:expr) => {
$(#[$meta])*
#[doc = concat!(
"Returns the JSON Schema for ",
stringify!($ty),
" with the canonical ID."
)]
pub fn $fn_name() -> Schema {
schema_with_id::<$ty>($id_const)
}
};
}
define_schema_fn!(pack_id, PackId, ids::PACK_ID);
define_schema_fn!(component_id, ComponentId, ids::COMPONENT_ID);
define_schema_fn!(flow_id, FlowId, ids::FLOW_ID);
define_schema_fn!(node_id, NodeId, ids::NODE_ID);
define_schema_fn!(flow, Flow, ids::FLOW);
define_schema_fn!(flow_resolve, FlowResolveV1, ids::FLOW_RESOLVE);
define_schema_fn!(
flow_resolve_summary,
FlowResolveSummaryV1,
ids::FLOW_RESOLVE_SUMMARY
);
define_schema_fn!(node, Node, ids::NODE);
define_schema_fn!(
component_manifest,
ComponentManifest,
ids::COMPONENT_MANIFEST
);
define_schema_fn!(pack_manifest, PackManifest, ids::PACK_MANIFEST);
define_schema_fn!(validation_severity, Severity, ids::VALIDATION_SEVERITY);
define_schema_fn!(
validation_diagnostic,
Diagnostic,
ids::VALIDATION_DIAGNOSTIC
);
define_schema_fn!(validation_report, ValidationReport, ids::VALIDATION_REPORT);
define_schema_fn!(provider_manifest, ProviderManifest, ids::PROVIDER_MANIFEST);
define_schema_fn!(
provider_runtime_ref,
ProviderRuntimeRef,
ids::PROVIDER_RUNTIME_REF
);
define_schema_fn!(provider_decl, ProviderDecl, ids::PROVIDER_DECL);
define_schema_fn!(
provider_extension_inline,
ProviderExtensionInline,
ids::PROVIDER_EXTENSION_INLINE
);
define_schema_fn!(
provider_install_record,
ProviderInstallRecord,
ids::PROVIDER_INSTALL_RECORD
);
define_schema_fn!(tenant_context, TenantContext, ids::TENANT_CONTEXT);
define_schema_fn!(hash_digest, HashDigest, ids::HASH_DIGEST);
define_schema_fn!(semver_req, SemverReq, ids::SEMVER_REQ);
define_schema_fn!(redaction_path, RedactionPath, ids::REDACTION_PATH);
define_schema_fn!(capabilities, Capabilities, ids::CAPABILITIES);
define_schema_fn!(repo_skin, RepoSkin, ids::REPO_SKIN);
define_schema_fn!(repo_auth, RepoAuth, ids::REPO_AUTH);
define_schema_fn!(
repo_tenant_config,
RepoTenantConfig,
ids::REPO_TENANT_CONFIG
);
define_schema_fn!(
tenant_did_document,
TenantDidDocument,
ids::TENANT_DID_DOCUMENT
);
define_schema_fn!(limits, Limits, ids::LIMITS);
define_schema_fn!(telemetry_spec, TelemetrySpec, ids::TELEMETRY_SPEC);
define_schema_fn!(node_summary, NodeSummary, ids::NODE_SUMMARY);
define_schema_fn!(node_failure, NodeFailure, ids::NODE_FAILURE);
define_schema_fn!(node_status, NodeStatus, ids::NODE_STATUS);
define_schema_fn!(run_status, RunStatus, ids::RUN_STATUS);
define_schema_fn!(transcript_offset, TranscriptOffset, ids::TRANSCRIPT_OFFSET);
define_schema_fn!(tools_caps, ToolsCaps, ids::TOOLS_CAPS);
define_schema_fn!(secrets_caps, SecretsCaps, ids::SECRETS_CAPS);
define_schema_fn!(branch_ref, BranchRef, ids::BRANCH_REF);
define_schema_fn!(commit_ref, CommitRef, ids::COMMIT_REF);
define_schema_fn!(git_provider_ref, GitProviderRef, ids::GIT_PROVIDER_REF);
define_schema_fn!(scanner_ref, ScannerRef, ids::SCANNER_REF);
define_schema_fn!(webhook_id, WebhookId, ids::WEBHOOK_ID);
define_schema_fn!(
provider_install_id,
ProviderInstallId,
ids::PROVIDER_INSTALL_ID
);
define_schema_fn!(repo_ref, RepoRef, ids::REPO_REF);
define_schema_fn!(component_ref, ComponentRef, ids::COMPONENT_REF);
define_schema_fn!(version_ref, VersionRef, ids::VERSION_REF);
define_schema_fn!(build_ref, BuildRef, ids::BUILD_REF);
define_schema_fn!(scan_ref, ScanRef, ids::SCAN_REF);
define_schema_fn!(attestation_ref, AttestationRef, ids::ATTESTATION_REF);
define_schema_fn!(attestation_id, AttestationId, ids::ATTESTATION_ID);
define_schema_fn!(policy_ref, PolicyRef, ids::POLICY_REF);
define_schema_fn!(policy_input_ref, PolicyInputRef, ids::POLICY_INPUT_REF);
define_schema_fn!(store_ref, StoreRef, ids::STORE_REF);
define_schema_fn!(registry_ref, RegistryRef, ids::REGISTRY_REF);
define_schema_fn!(oci_image_ref, OciImageRef, ids::OCI_IMAGE_REF);
define_schema_fn!(artifact_ref, ArtifactRef, ids::ARTIFACT_REF);
define_schema_fn!(sbom_ref, SbomRef, ids::SBOM_REF);
define_schema_fn!(signing_key_ref, SigningKeyRef, ids::SIGNING_KEY_REF);
define_schema_fn!(signature_ref, SignatureRef, ids::SIGNATURE_REF);
define_schema_fn!(statement_ref, StatementRef, ids::STATEMENT_REF);
define_schema_fn!(build_log_ref, BuildLogRef, ids::BUILD_LOG_REF);
define_schema_fn!(
metadata_record_ref,
MetadataRecordRef,
ids::METADATA_RECORD_REF
);
define_schema_fn!(api_key_ref, ApiKeyRef, ids::API_KEY_REF);
define_schema_fn!(environment_ref, EnvironmentRef, ids::ENVIRONMENT_REF);
define_schema_fn!(distributor_ref, crate::DistributorRef, ids::DISTRIBUTOR_REF);
define_schema_fn!(storefront_id, crate::StoreFrontId, ids::STOREFRONT_ID);
define_schema_fn!(
store_product_id,
crate::StoreProductId,
ids::STORE_PRODUCT_ID
);
define_schema_fn!(store_plan_id, crate::StorePlanId, ids::STORE_PLAN_ID);
define_schema_fn!(subscription_id, crate::SubscriptionId, ids::SUBSCRIPTION_ID);
define_schema_fn!(bundle_id, crate::BundleId, ids::BUNDLE_ID);
define_schema_fn!(collection_id, crate::CollectionId, ids::COLLECTION_ID);
define_schema_fn!(build_plan, BuildPlan, ids::BUILD_PLAN);
define_schema_fn!(build_status, BuildStatus, ids::BUILD_STATUS);
define_schema_fn!(scan_request, ScanRequest, ids::SCAN_REQUEST);
define_schema_fn!(scan_result, ScanResult, ids::SCAN_RESULT);
define_schema_fn!(sign_request, SignRequest, ids::SIGN_REQUEST);
define_schema_fn!(verify_request, VerifyRequest, ids::VERIFY_REQUEST);
define_schema_fn!(verify_result, VerifyResult, ids::VERIFY_RESULT);
define_schema_fn!(
attestation_statement,
AttestationStatement,
ids::ATTESTATION_STATEMENT
);
define_schema_fn!(metadata_record, MetadataRecord, ids::METADATA_RECORD);
define_schema_fn!(repo_context, RepoContext, ids::REPO_CONTEXT);
define_schema_fn!(store_context, StoreContext, ids::STORE_CONTEXT);
define_schema_fn!(event_envelope, EventEnvelope, ids::EVENT_ENVELOPE);
define_schema_fn!(
event_provider_descriptor,
EventProviderDescriptor,
ids::EVENT_PROVIDER_DESCRIPTOR
);
define_schema_fn!(
channel_message_envelope,
ChannelMessageEnvelope,
ids::CHANNEL_MESSAGE_ENVELOPE
);
define_schema_fn!(attachment, Attachment, ids::ATTACHMENT);
define_schema_fn!(worker_request, WorkerRequest, ids::WORKER_REQUEST);
define_schema_fn!(worker_message, WorkerMessage, ids::WORKER_MESSAGE);
define_schema_fn!(worker_response, WorkerResponse, ids::WORKER_RESPONSE);
define_schema_fn!(bundle_spec, BundleSpec, ids::BUNDLE);
define_schema_fn!(
desired_state_export_spec,
DesiredStateExportSpec,
ids::DESIRED_STATE_EXPORT
);
define_schema_fn!(desired_state, DesiredState, ids::DESIRED_STATE);
define_schema_fn!(
desired_subscription_entry,
DesiredSubscriptionEntry,
ids::DESIRED_SUBSCRIPTION_ENTRY
);
define_schema_fn!(artifact_selector, ArtifactSelector, ids::ARTIFACT_SELECTOR);
define_schema_fn!(storefront, StoreFront, ids::STOREFRONT);
define_schema_fn!(store_product, StoreProduct, ids::STORE_PRODUCT);
define_schema_fn!(store_plan, StorePlan, ids::STORE_PLAN);
define_schema_fn!(capability_map, CapabilityMap, ids::CAPABILITY_MAP);
define_schema_fn!(subscription, Subscription, ids::SUBSCRIPTION);
define_schema_fn!(environment, Environment, ids::ENVIRONMENT);
define_schema_fn!(rollout_status, RolloutStatus, ids::ROLLOUT_STATUS);
define_schema_fn!(theme, Theme, ids::THEME);
define_schema_fn!(layout_section, LayoutSection, ids::LAYOUT_SECTION);
define_schema_fn!(collection, Collection, ids::COLLECTION);
define_schema_fn!(product_override, ProductOverride, ids::PRODUCT_OVERRIDE);
define_schema_fn!(
store_product_kind,
StoreProductKind,
ids::STORE_PRODUCT_KIND
);
define_schema_fn!(version_strategy, VersionStrategy, ids::VERSION_STRATEGY);
define_schema_fn!(connection_kind, ConnectionKind, ids::CONNECTION_KIND);
define_schema_fn!(
pack_or_component_ref,
PackOrComponentRef,
ids::PACK_OR_COMPONENT_REF
);
define_schema_fn!(plan_limits, PlanLimits, ids::PLAN_LIMITS);
define_schema_fn!(price_model, PriceModel, ids::PRICE_MODEL);
define_schema_fn!(
subscription_status,
SubscriptionStatus,
ids::SUBSCRIPTION_STATUS
);
#[cfg(feature = "otel-keys")]
define_schema_fn!(otlp_keys, OtlpKeys, ids::OTLP_KEYS);
#[cfg(feature = "time")]
define_schema_fn!(run_result, RunResult, ids::RUN_RESULT);
#[allow(unused_macros)]
macro_rules! schema_entries_vec {
( $( $(#[$meta:meta])* { $fn_name:ident, $slug:literal, $id_const:expr } ),+ $(,)? ) => {
#[cfg(feature = "schema")]
pub(crate) fn entries() -> Vec<SchemaEntry> {
let mut entries = Vec::new();
$(
$(#[$meta])*
{
entries.push(SchemaEntry {
file_name: concat!($slug, ".schema.json"),
generator: $fn_name,
});
}
)+
entries
}
};
}
#[cfg(feature = "schema")]
schema_entries_vec! {
{ pack_id, "pack-id", ids::PACK_ID },
{ component_id, "component-id", ids::COMPONENT_ID },
{ flow_id, "flow-id", ids::FLOW_ID },
{ node_id, "node-id", ids::NODE_ID },
{ tenant_context, "tenant-context", ids::TENANT_CONTEXT },
{ hash_digest, "hash-digest", ids::HASH_DIGEST },
{ semver_req, "semver-req", ids::SEMVER_REQ },
{ redaction_path, "redaction-path", ids::REDACTION_PATH },
{ capabilities, "capabilities", ids::CAPABILITIES },
{ repo_skin, "repo-skin", ids::REPO_SKIN },
{ repo_auth, "repo-auth", ids::REPO_AUTH },
{ repo_tenant_config, "repo-tenant-config", ids::REPO_TENANT_CONFIG },
{ tenant_did_document, "tenant-did-document", ids::TENANT_DID_DOCUMENT },
{ flow, "flow", ids::FLOW },
{ flow_resolve, "flow-resolve", ids::FLOW_RESOLVE },
{ flow_resolve_summary, "flow-resolve-summary", ids::FLOW_RESOLVE_SUMMARY },
{ node, "node", ids::NODE },
{ component_manifest, "component-manifest", ids::COMPONENT_MANIFEST },
{ pack_manifest, "pack-manifest", ids::PACK_MANIFEST },
{ validation_severity, "validation-severity", ids::VALIDATION_SEVERITY },
{ validation_diagnostic, "validation-diagnostic", ids::VALIDATION_DIAGNOSTIC },
{ validation_report, "validation-report", ids::VALIDATION_REPORT },
{ provider_manifest, "provider-manifest", ids::PROVIDER_MANIFEST },
{ provider_runtime_ref, "provider-runtime-ref", ids::PROVIDER_RUNTIME_REF },
{ provider_decl, "provider-decl", ids::PROVIDER_DECL },
{ provider_extension_inline, "provider-extension-inline", ids::PROVIDER_EXTENSION_INLINE },
{ provider_install_record, "provider-install-record", ids::PROVIDER_INSTALL_RECORD },
{ limits, "limits", ids::LIMITS },
{ telemetry_spec, "telemetry-spec", ids::TELEMETRY_SPEC },
{ node_summary, "node-summary", ids::NODE_SUMMARY },
{ node_failure, "node-failure", ids::NODE_FAILURE },
{ node_status, "node-status", ids::NODE_STATUS },
{ run_status, "run-status", ids::RUN_STATUS },
{ transcript_offset, "transcript-offset", ids::TRANSCRIPT_OFFSET },
{ tools_caps, "tools-caps", ids::TOOLS_CAPS },
{ secrets_caps, "secrets-caps", ids::SECRETS_CAPS },
{ branch_ref, "branch-ref", ids::BRANCH_REF },
{ commit_ref, "commit-ref", ids::COMMIT_REF },
{ git_provider_ref, "git-provider-ref", ids::GIT_PROVIDER_REF },
{ scanner_ref, "scanner-ref", ids::SCANNER_REF },
{ webhook_id, "webhook-id", ids::WEBHOOK_ID },
{ provider_install_id, "provider-install-id", ids::PROVIDER_INSTALL_ID },
{ repo_ref, "repo-ref", ids::REPO_REF },
{ component_ref, "component-ref", ids::COMPONENT_REF },
{ version_ref, "version-ref", ids::VERSION_REF },
{ build_ref, "build-ref", ids::BUILD_REF },
{ scan_ref, "scan-ref", ids::SCAN_REF },
{ attestation_ref, "attestation-ref", ids::ATTESTATION_REF },
{ attestation_id, "attestation-id", ids::ATTESTATION_ID },
{ policy_ref, "policy-ref", ids::POLICY_REF },
{ policy_input_ref, "policy-input-ref", ids::POLICY_INPUT_REF },
{ store_ref, "store-ref", ids::STORE_REF },
{ registry_ref, "registry-ref", ids::REGISTRY_REF },
{ oci_image_ref, "oci-image-ref", ids::OCI_IMAGE_REF },
{ artifact_ref, "artifact-ref", ids::ARTIFACT_REF },
{ sbom_ref, "sbom-ref", ids::SBOM_REF },
{ signing_key_ref, "signing-key-ref", ids::SIGNING_KEY_REF },
{ signature_ref, "signature-ref", ids::SIGNATURE_REF },
{ statement_ref, "statement-ref", ids::STATEMENT_REF },
{ build_log_ref, "build-log-ref", ids::BUILD_LOG_REF },
{ metadata_record_ref, "metadata-record-ref", ids::METADATA_RECORD_REF },
{ api_key_ref, "api-key-ref", ids::API_KEY_REF },
{ environment_ref, "environment-ref", ids::ENVIRONMENT_REF },
{ distributor_ref, "distributor-ref", ids::DISTRIBUTOR_REF },
{ storefront_id, "storefront-id", ids::STOREFRONT_ID },
{ store_product_id, "store-product-id", ids::STORE_PRODUCT_ID },
{ store_plan_id, "store-plan-id", ids::STORE_PLAN_ID },
{ subscription_id, "subscription-id", ids::SUBSCRIPTION_ID },
{ bundle_id, "bundle-id", ids::BUNDLE_ID },
{ collection_id, "collection-id", ids::COLLECTION_ID },
{ build_plan, "build-plan", ids::BUILD_PLAN },
{ build_status, "build-status", ids::BUILD_STATUS },
{ rollout_status, "rollout-status", ids::ROLLOUT_STATUS },
{ scan_request, "scan-request", ids::SCAN_REQUEST },
{ scan_result, "scan-result", ids::SCAN_RESULT },
{ sign_request, "sign-request", ids::SIGN_REQUEST },
{ verify_request, "verify-request", ids::VERIFY_REQUEST },
{ verify_result, "verify-result", ids::VERIFY_RESULT },
{ attestation_statement, "attestation-statement", ids::ATTESTATION_STATEMENT },
{ metadata_record, "metadata-record", ids::METADATA_RECORD },
{ repo_context, "repo-context", ids::REPO_CONTEXT },
{ store_context, "store-context", ids::STORE_CONTEXT },
{ event_envelope, "event-envelope", ids::EVENT_ENVELOPE },
{ event_provider_descriptor, "event-provider-descriptor", ids::EVENT_PROVIDER_DESCRIPTOR },
{ channel_message_envelope, "channel-message-envelope", ids::CHANNEL_MESSAGE_ENVELOPE },
{ attachment, "attachment", ids::ATTACHMENT },
{ worker_request, "worker-request", ids::WORKER_REQUEST },
{ worker_message, "worker-message", ids::WORKER_MESSAGE },
{ worker_response, "worker-response", ids::WORKER_RESPONSE },
{ bundle_spec, "bundle", ids::BUNDLE },
{ desired_state_export_spec, "desired-state-export", ids::DESIRED_STATE_EXPORT },
{ desired_state, "desired-state", ids::DESIRED_STATE },
{ desired_subscription_entry, "desired-subscription-entry", ids::DESIRED_SUBSCRIPTION_ENTRY },
{ artifact_selector, "artifact-selector", ids::ARTIFACT_SELECTOR },
{ storefront, "storefront", ids::STOREFRONT },
{ store_product, "store-product", ids::STORE_PRODUCT },
{ store_plan, "store-plan", ids::STORE_PLAN },
{ capability_map, "capability-map", ids::CAPABILITY_MAP },
{ subscription, "subscription", ids::SUBSCRIPTION },
{ environment, "environment", ids::ENVIRONMENT },
{ theme, "theme", ids::THEME },
{ layout_section, "layout-section", ids::LAYOUT_SECTION },
{ collection, "collection", ids::COLLECTION },
{ product_override, "product-override", ids::PRODUCT_OVERRIDE },
{ store_product_kind, "store-product-kind", ids::STORE_PRODUCT_KIND },
{ version_strategy, "version-strategy", ids::VERSION_STRATEGY },
{ connection_kind, "connection-kind", ids::CONNECTION_KIND },
{ pack_or_component_ref, "pack-or-component-ref", ids::PACK_OR_COMPONENT_REF },
{ plan_limits, "plan-limits", ids::PLAN_LIMITS },
{ price_model, "price-model", ids::PRICE_MODEL },
{ subscription_status, "subscription-status", ids::SUBSCRIPTION_STATUS },
#[cfg(feature = "otel-keys")]
{ otlp_keys, "otlp-keys", ids::OTLP_KEYS },
#[cfg(feature = "time")]
{ run_result, "run-result", ids::RUN_RESULT },
}