Struct kube_core::schema::StructuralSchemaRewriter

pub struct StructuralSchemaRewriter;

schemars Visitor that rewrites a Schema to conform to Kubernetes’ “structural schema” rules

The following two transformations are applied

• Rewrite enums from oneOf to objects with multiple variants (schemars#84)
• Rewrite untagged enums from anyOf to objects with multiple variants (kube#1028)
• Rewrite additionalProperties from #[serde(flatten)] to x-kubernetes-preserve-unknown-fields (kube#844)

This is used automatically by kube::derive’s #[derive(CustomResource)], but it can also be used manually with SchemaSettings::with_visitor.

Panics

The Visitor functions may panic if the transform could not be applied. For example, there must not be any overlapping properties between oneOf branches.

Trait Implementations

impl Clone for StructuralSchemaRewriter

fn clone(&self) -> StructuralSchemaRewriter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StructuralSchemaRewriter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Visitor for StructuralSchemaRewriter

fn visit_schema_object(&mut self, schema: &mut SchemaObject)

Override this method to modify a SchemaObject and (optionally) its subschemas.

fn visit_root_schema(&mut self, root: &mut RootSchema)

Override this method to modify a RootSchema and (optionally) its subschemas.

fn visit_schema(&mut self, schema: &mut Schema)

Override this method to modify a Schema and (optionally) its subschemas.