Expand description
Shared metadata types for Kinetic’s documentation generation pipeline.
These types are referenced by:
- The
kinetic-doc-deriveproc-macro (generated code uses these types) - The
doc-gentool (reads/writesComponentMetadataas JSON) - Any crate that derives
ComponentDoc
Structs§
- Component
Metadata - Metadata for a single component (source, transform, or sink).
- Component
Registry - Collection of all component metadata for the intermediate representation.
- Enum
Value Metadata - Metadata for an enum variant.
- EnvVar
Metadata - Metadata for an environment variable.
- Field
Metadata - Metadata for a single configuration field.
- Metric
Metadata - Metadata for a component-specific metric.
- Output
Field Metadata - Metadata for an output field (sources only).
- Permission
Metadata - Metadata for a required IAM permission.
- Variant
Metadata - Metadata for a polymorphic enum variant (e.g., Random, Systematic in SamplingMode).
Traits§
- HasEnum
Metadata - Marker trait for enums to provide metadata about their variants.
- HasFields
Metadata - Trait for types that can provide metadata about their fields.
- HasVariant
Metadata - Trait for polymorphic enums to provide variant schema metadata.