Add support for the new gets_restored metadata introduced in redpanda-data/redpanda#25105

Author: JakeSCahill

tools/property-extractor/json-to-asciidoc/generate_docs.py

@@ -251,6 +251,10 @@ def generate_property_doc(key, value):
         restart = "Yes" if value.get("needs_restart", False) else "No"
         lines.append(f"*Requires restart:* {restart}\n\n")
 
+    if "gets_restored" in value:
+        restored = "Yes" if value.get("gets_restored", False) else "No"
+        lines.append(f"*Gets restored during cluster restore:* {restored}\n\n")
+
     visibility = value.get("visibility") or "user"
     lines.append(f"*Visibility:* `{visibility}`\n\n")
 

tools/property-extractor/property_extractor.py

@@ -94,6 +94,7 @@ def transform_files_with_properties(files_with_properties):
         IsNullableTransformer(),
         IsArrayTransformer(type_transformer),
         NeedsRestartTransformer(),
+        GetsRestoredTransformer(),
         VisibilityTransformer(),
         DeprecatedTransformer(),
         IsSecretTransformer(),
@@ -132,7 +133,7 @@ def merge_properties_and_definitions(properties, definitions):
         # guard against missing "type"
         prop_type = property.get("type")
         if prop_type and prop_type in definitions:
-            properties[name]["type"] = f"#/definitions/{prop_type}"
+            properties[name]["type"] = "#/definitions/{prop_type}"
         elif (
             prop_type == "array"
             and property.get("items", {}).get("type") in definitions

tools/property-extractor/transformers.py

@@ -62,6 +62,22 @@ def parse(self, property, info, file_pair):
             )
         property["needs_restart"] = needs_restart != "no"  # True by default, unless we find "no"
 
+class GetsRestoredTransformer:
+    def accepts(self, info, file_pair):
+        # only run if the third param blob exists and has our flag
+        return (
+            len(info.get("params", [])) > 2
+            and isinstance(info["params"][2].get("value"), dict)
+            and "gets_restored" in info["params"][2]["value"]
+        )
+
+    def parse(self, property, info, file_pair):
+        raw = info["params"][2]["value"]["gets_restored"]
+        # strip off e.g. "gets_restored::no" → "no"
+        flag = re.sub(r"^.*::", "", raw)
+        # store as boolean
+        property["gets_restored"] = (flag != "no")
+
 
 class VisibilityTransformer:
     def accepts(self, info, file_pair):