fix: Add descriptions for batch_config properties (#1771)

add descriptions for batch_config properties
meltano · Jun 19, 2023 · e877215 · e877215
1 parent d7a1e79
commit e877215
Showing 1 changed file with 17 additions and 3 deletions.
diff --git a/singer_sdk/helpers/capabilities.py b/singer_sdk/helpers/capabilities.py
@@ -59,20 +59,34 @@
                 "encoding",
                 description="Specifies the format and compression of the batch files.",
                 wrapped=ObjectType(
-                    Property("format", StringType, allowed_values=["jsonl"]),
+                    Property(
+                        "format",
+                        StringType,
+                        allowed_values=["jsonl"],
+                        description="Format to use for batch files.",
+                    ),
                     Property(
                         "compression",
                         StringType,
                         allowed_values=["gzip", "none"],
+                        description="Compression format to use for batch files.",
                     ),
                 ),
             ),
             Property(
                 "storage",
                 description="Defines the storage layer to use when writing batch files",
                 wrapped=ObjectType(
-                    Property("root", StringType),
-                    Property("prefix", StringType),
+                    Property(
+                        "root",
+                        StringType,
+                        description="Root path to use when writing batch files.",
+                    ),
+                    Property(
+                        "prefix",
+                        StringType,
+                        description="Prefix to use when writing batch files.",
+                    ),
                 ),
             ),
         ),