chore(stackable-versioned): Add FIXME comments

Author: Techassi

crates/stackable-versioned-macros/src/codegen/container/struct/conversion.rs

@@ -164,6 +164,11 @@ impl Struct {
             }
         };
 
+        // FIXME (@Techassi): Both inserts and removals currently "leak" how the fields are named
+        // internally in Rust and not what they are serialized as (camelCase most of the time). This
+        // can be especially confusing for users who look at the status and see those field names.
+        // Ideally we would integrate with the serde(rename) functionality to produce these field
+        // names.
         let inserts = self.generate_tracking_inserts(direction, next_version, mod_gen_ctx);
         let removals = self.generate_tracking_removals(direction, next_version, mod_gen_ctx);
         let json_paths = self.generate_json_paths(next_version);

crates/stackable-versioned/src/lib.rs

@@ -59,9 +59,10 @@ pub trait TrackingStatus {
 }
 
 // NOTE (@Techassi): This struct represents a rough first draft of how tracking values across
-// CRD versions can be achieved. It is currently untested and unproven and might change down the
-// line. Currently, this struct is only generated by the macro but not actually used by any other
-// code. The tracking itself will be introduced in a follow-up PR.
+// CRD versions can be achieved. It might change down the line.
+// FIXME (@Techassi): Ideally we don't serialize empty maps. Further, we shouldn't serialize the
+// changedValues field in the status, if there it is empty. This currently "pollutes" the status
+// with empty JSON objects.
 /// Contains changed values during upgrades and downgrades of CRDs.
 #[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub struct ChangedValues {